/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
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
import SocketServer as socketserver
 
37
from future_builtins import *
 
38
 
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
38
43
import socket
39
44
import argparse
40
45
import datetime
45
50
import gnutls.library.functions
46
51
import gnutls.library.constants
47
52
import gnutls.library.types
48
 
import ConfigParser as configparser
 
53
try:
 
54
    import ConfigParser as configparser
 
55
except ImportError:
 
56
    import configparser
49
57
import sys
50
58
import re
51
59
import os
60
68
import struct
61
69
import fcntl
62
70
import functools
63
 
import cPickle as pickle
 
71
try:
 
72
    import cPickle as pickle
 
73
except ImportError:
 
74
    import pickle
64
75
import multiprocessing
65
76
import types
66
 
import hashlib
 
77
import binascii
 
78
import tempfile
 
79
import itertools
 
80
import collections
 
81
import codecs
67
82
 
68
83
import dbus
69
84
import dbus.service
70
 
import gobject
 
85
try:
 
86
    import gobject
 
87
except ImportError:
 
88
    from gi.repository import GObject as gobject
71
89
import avahi
72
90
from dbus.mainloop.glib import DBusGMainLoop
73
91
import ctypes
74
92
import ctypes.util
75
93
import xml.dom.minidom
76
94
import inspect
77
 
import Crypto.Cipher.AES
78
95
 
79
96
try:
80
97
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
84
101
    except ImportError:
85
102
        SO_BINDTODEVICE = None
86
103
 
 
104
if sys.version_info.major == 2:
 
105
    str = unicode
87
106
 
88
 
version = "1.4.1"
 
107
version = "1.6.9"
 
108
stored_state_file = "clients.pickle"
89
109
 
90
110
logger = logging.getLogger()
91
 
stored_state_path = "/var/lib/mandos/clients.pickle"
92
 
 
93
 
syslogger = (logging.handlers.SysLogHandler
94
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
 
              address = str("/dev/log")))
96
 
syslogger.setFormatter(logging.Formatter
97
 
                       ('Mandos [%(process)d]: %(levelname)s:'
98
 
                        ' %(message)s'))
99
 
logger.addHandler(syslogger)
100
 
 
101
 
console = logging.StreamHandler()
102
 
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
103
 
                                       ' [%(process)d]:'
104
 
                                       ' %(levelname)s:'
105
 
                                       ' %(message)s'))
106
 
logger.addHandler(console)
 
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
107
235
 
108
236
 
109
237
class AvahiError(Exception):
110
238
    def __init__(self, value, *args, **kwargs):
111
239
        self.value = value
112
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
113
 
    def __unicode__(self):
114
 
        return unicode(repr(self.value))
 
240
        return super(AvahiError, self).__init__(value, *args,
 
241
                                                **kwargs)
 
242
 
115
243
 
116
244
class AvahiServiceError(AvahiError):
117
245
    pass
118
246
 
 
247
 
119
248
class AvahiGroupError(AvahiError):
120
249
    pass
121
250
 
128
257
               Used to optionally bind to the specified interface.
129
258
    name: string; Example: 'Mandos'
130
259
    type: string; Example: '_mandos._tcp'.
131
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
260
     See <https://www.iana.org/assignments/service-names-port-numbers>
132
261
    port: integer; what port to announce
133
262
    TXT: list of strings; TXT record for the service
134
263
    domain: string; Domain to publish on, default to .local if empty.
140
269
    server: D-Bus Server
141
270
    bus: dbus.SystemBus()
142
271
    """
143
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
144
 
                 servicetype = None, port = None, TXT = None,
145
 
                 domain = "", host = "", max_renames = 32768,
146
 
                 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):
147
284
        self.interface = interface
148
285
        self.name = name
149
286
        self.type = servicetype
158
295
        self.server = None
159
296
        self.bus = bus
160
297
        self.entry_group_state_changed_match = None
161
 
    def rename(self):
 
298
    
 
299
    def rename(self, remove=True):
162
300
        """Derived from the Avahi example code"""
163
301
        if self.rename_count >= self.max_renames:
164
302
            logger.critical("No suitable Zeroconf service name found"
165
303
                            " after %i retries, exiting.",
166
304
                            self.rename_count)
167
305
            raise AvahiServiceError("Too many renames")
168
 
        self.name = unicode(self.server
169
 
                            .GetAlternativeServiceName(self.name))
 
306
        self.name = str(
 
307
            self.server.GetAlternativeServiceName(self.name))
 
308
        self.rename_count += 1
170
309
        logger.info("Changing Zeroconf service name to %r ...",
171
310
                    self.name)
172
 
        self.remove()
 
311
        if remove:
 
312
            self.remove()
173
313
        try:
174
314
            self.add()
175
315
        except dbus.exceptions.DBusException as error:
176
 
            logger.critical("DBusException: %s", error)
177
 
            self.cleanup()
178
 
            os._exit(1)
179
 
        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
    
180
325
    def remove(self):
181
326
        """Derived from the Avahi example code"""
182
327
        if self.entry_group_state_changed_match is not None:
184
329
            self.entry_group_state_changed_match = None
185
330
        if self.group is not None:
186
331
            self.group.Reset()
 
332
    
187
333
    def add(self):
188
334
        """Derived from the Avahi example code"""
189
335
        self.remove()
206
352
            dbus.UInt16(self.port),
207
353
            avahi.string_array_to_txt_array(self.TXT))
208
354
        self.group.Commit()
 
355
    
209
356
    def entry_group_state_changed(self, state, error):
210
357
        """Derived from the Avahi example code"""
211
358
        logger.debug("Avahi entry group state change: %i", state)
217
364
            self.rename()
218
365
        elif state == avahi.ENTRY_GROUP_FAILURE:
219
366
            logger.critical("Avahi: Error in group state changed %s",
220
 
                            unicode(error))
221
 
            raise AvahiGroupError("State changed: %s"
222
 
                                  % unicode(error))
 
367
                            str(error))
 
368
            raise AvahiGroupError("State changed: {!s}".format(error))
 
369
    
223
370
    def cleanup(self):
224
371
        """Derived from the Avahi example code"""
225
372
        if self.group is not None:
226
373
            try:
227
374
                self.group.Free()
228
375
            except (dbus.exceptions.UnknownMethodException,
229
 
                    dbus.exceptions.DBusException) as e:
 
376
                    dbus.exceptions.DBusException):
230
377
                pass
231
378
            self.group = None
232
379
        self.remove()
 
380
    
233
381
    def server_state_changed(self, state, error=None):
234
382
        """Derived from the Avahi example code"""
235
383
        logger.debug("Avahi server state change: %i", state)
236
 
        bad_states = { avahi.SERVER_INVALID:
237
 
                           "Zeroconf server invalid",
238
 
                       avahi.SERVER_REGISTERING: None,
239
 
                       avahi.SERVER_COLLISION:
240
 
                           "Zeroconf server name collision",
241
 
                       avahi.SERVER_FAILURE:
242
 
                           "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
        }
243
390
        if state in bad_states:
244
391
            if bad_states[state] is not None:
245
392
                if error is None:
254
401
                logger.debug("Unknown state: %r", state)
255
402
            else:
256
403
                logger.debug("Unknown state: %r: %r", state, error)
 
404
    
257
405
    def activate(self):
258
406
        """Derived from the Avahi example code"""
259
407
        if self.server is None:
263
411
                                    follow_name_owner_changes=True),
264
412
                avahi.DBUS_INTERFACE_SERVER)
265
413
        self.server.connect_to_signal("StateChanged",
266
 
                                 self.server_state_changed)
 
414
                                      self.server_state_changed)
267
415
        self.server_state_changed(self.server.GetState())
268
416
 
 
417
 
269
418
class AvahiServiceToSyslog(AvahiService):
270
 
    def rename(self):
 
419
    def rename(self, *args, **kwargs):
271
420
        """Add the new name to the syslog messages"""
272
 
        ret = AvahiService.rename(self)
273
 
        syslogger.setFormatter(logging.Formatter
274
 
                               ('Mandos (%s) [%%(process)d]:'
275
 
                                ' %%(levelname)s: %%(message)s'
276
 
                                % self.name))
 
421
        ret = AvahiService.rename(self, *args, **kwargs)
 
422
        syslogger.setFormatter(logging.Formatter(
 
423
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
424
            .format(self.name)))
277
425
        return ret
278
426
 
279
 
def _timedelta_to_milliseconds(td):
280
 
    "Convert a datetime.timedelta() to milliseconds"
281
 
    return ((td.days * 24 * 60 * 60 * 1000)
282
 
            + (td.seconds * 1000)
283
 
            + (td.microseconds // 1000))
284
 
        
 
427
 
285
428
class Client(object):
286
429
    """A representation of a client host served by this server.
287
430
    
288
431
    Attributes:
289
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
432
    approved:   bool(); 'None' if not yet approved/disapproved
290
433
    approval_delay: datetime.timedelta(); Time to wait for approval
291
434
    approval_duration: datetime.timedelta(); Duration of one approval
292
435
    checker:    subprocess.Popen(); a running checker process used
311
454
    last_approval_request: datetime.datetime(); (UTC) or None
312
455
    last_checked_ok: datetime.datetime(); (UTC) or None
313
456
    last_checker_status: integer between 0 and 255 reflecting exit
314
 
                         status of last checker. -1 reflect crashed
315
 
                         checker, or None.
316
 
    last_enabled: datetime.datetime(); (UTC)
 
457
                         status of last checker. -1 reflects crashed
 
458
                         checker, -2 means no checker completed yet.
 
459
    last_enabled: datetime.datetime(); (UTC) or None
317
460
    name:       string; from the config file, used in log messages and
318
461
                        D-Bus identifiers
319
462
    secret:     bytestring; sent verbatim (over TLS) to client
320
463
    timeout:    datetime.timedelta(); How long from last_checked_ok
321
464
                                      until this client is disabled
322
 
    extended_timeout:   extra long timeout when password has been sent
 
465
    extended_timeout:   extra long timeout when secret has been sent
323
466
    runtime_expansions: Allowed attributes for runtime expansion.
324
467
    expires:    datetime.datetime(); time (UTC) when a client will be
325
468
                disabled, or None
 
469
    server_settings: The server_settings dict from main()
326
470
    """
327
471
    
328
472
    runtime_expansions = ("approval_delay", "approval_duration",
329
 
                          "created", "enabled", "fingerprint",
330
 
                          "host", "interval", "last_checked_ok",
 
473
                          "created", "enabled", "expires",
 
474
                          "fingerprint", "host", "interval",
 
475
                          "last_approval_request", "last_checked_ok",
331
476
                          "last_enabled", "name", "timeout")
332
 
    
333
 
    def timeout_milliseconds(self):
334
 
        "Return the 'timeout' attribute in milliseconds"
335
 
        return _timedelta_to_milliseconds(self.timeout)
336
 
    
337
 
    def extended_timeout_milliseconds(self):
338
 
        "Return the 'extended_timeout' attribute in milliseconds"
339
 
        return _timedelta_to_milliseconds(self.extended_timeout)
340
 
    
341
 
    def interval_milliseconds(self):
342
 
        "Return the 'interval' attribute in milliseconds"
343
 
        return _timedelta_to_milliseconds(self.interval)
344
 
    
345
 
    def approval_delay_milliseconds(self):
346
 
        return _timedelta_to_milliseconds(self.approval_delay)
347
 
    
348
 
    def __init__(self, name = None, config=None):
349
 
        """Note: the 'checker' key in 'config' sets the
350
 
        'checker_command' attribute and *not* the 'checker'
351
 
        attribute."""
 
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
    }
 
488
    
 
489
    @staticmethod
 
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):
352
540
        self.name = name
353
 
        if config is None:
354
 
            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
        
355
558
        logger.debug("Creating client %r", self.name)
356
 
        # Uppercase and remove spaces from fingerprint for later
357
 
        # comparison purposes with return value from the fingerprint()
358
 
        # function
359
 
        self.fingerprint = (config["fingerprint"].upper()
360
 
                            .replace(" ", ""))
361
559
        logger.debug("  Fingerprint: %s", self.fingerprint)
362
 
        if "secret" in config:
363
 
            self.secret = config["secret"].decode("base64")
364
 
        elif "secfile" in config:
365
 
            with open(os.path.expanduser(os.path.expandvars
366
 
                                         (config["secfile"])),
367
 
                      "rb") as secfile:
368
 
                self.secret = secfile.read()
369
 
        else:
370
 
            raise TypeError("No secret or secfile for client %s"
371
 
                            % self.name)
372
 
        self.host = config.get("host", "")
373
 
        self.created = datetime.datetime.utcnow()
374
 
        self.enabled = True
375
 
        self.last_approval_request = None
376
 
        self.last_enabled = datetime.datetime.utcnow()
377
 
        self.last_checked_ok = None
378
 
        self.last_checker_status = None
379
 
        self.timeout = string_to_delta(config["timeout"])
380
 
        self.extended_timeout = string_to_delta(config
381
 
                                                ["extended_timeout"])
382
 
        self.interval = string_to_delta(config["interval"])
 
560
        self.created = settings.get("created",
 
561
                                    datetime.datetime.utcnow())
 
562
        
 
563
        # attributes specific for this server instance
383
564
        self.checker = None
384
565
        self.checker_initiator_tag = None
385
566
        self.disable_initiator_tag = None
386
 
        self.expires = datetime.datetime.utcnow() + self.timeout
387
567
        self.checker_callback_tag = None
388
 
        self.checker_command = config["checker"]
389
568
        self.current_checker_command = None
390
 
        self._approved = None
391
 
        self.approved_by_default = config.get("approved_by_default",
392
 
                                              True)
 
569
        self.approved = None
393
570
        self.approvals_pending = 0
394
 
        self.approval_delay = string_to_delta(
395
 
            config["approval_delay"])
396
 
        self.approval_duration = string_to_delta(
397
 
            config["approval_duration"])
398
 
        self.changedstate = (multiprocessing_manager
399
 
                             .Condition(multiprocessing_manager
400
 
                                        .Lock()))
401
 
        self.client_structure = [attr for attr
402
 
                                 in self.__dict__.iterkeys()
 
571
        self.changedstate = multiprocessing_manager.Condition(
 
572
            multiprocessing_manager.Lock())
 
573
        self.client_structure = [attr
 
574
                                 for attr in self.__dict__.iterkeys()
403
575
                                 if not attr.startswith("_")]
404
576
        self.client_structure.append("client_structure")
405
 
 
406
 
 
407
 
        for name, t in inspect.getmembers(type(self),
408
 
                                          lambda obj:
409
 
                                              isinstance(obj,
410
 
                                                         property)):
 
577
        
 
578
        for name, t in inspect.getmembers(
 
579
                type(self), lambda obj: isinstance(obj, property)):
411
580
            if not name.startswith("_"):
412
581
                self.client_structure.append(name)
413
582
    
421
590
        if getattr(self, "enabled", False):
422
591
            # Already enabled
423
592
            return
424
 
        self.send_changedstate()
425
593
        self.expires = datetime.datetime.utcnow() + self.timeout
426
594
        self.enabled = True
427
595
        self.last_enabled = datetime.datetime.utcnow()
428
596
        self.init_checker()
 
597
        self.send_changedstate()
429
598
    
430
599
    def disable(self, quiet=True):
431
600
        """Disable this client."""
432
601
        if not getattr(self, "enabled", False):
433
602
            return False
434
603
        if not quiet:
435
 
            self.send_changedstate()
436
 
        if not quiet:
437
604
            logger.info("Disabling client %s", self.name)
438
 
        if getattr(self, "disable_initiator_tag", False):
 
605
        if getattr(self, "disable_initiator_tag", None) is not None:
439
606
            gobject.source_remove(self.disable_initiator_tag)
440
607
            self.disable_initiator_tag = None
441
608
        self.expires = None
442
 
        if getattr(self, "checker_initiator_tag", False):
 
609
        if getattr(self, "checker_initiator_tag", None) is not None:
443
610
            gobject.source_remove(self.checker_initiator_tag)
444
611
            self.checker_initiator_tag = None
445
612
        self.stop_checker()
446
613
        self.enabled = False
 
614
        if not quiet:
 
615
            self.send_changedstate()
447
616
        # Do not run this again if called by a gobject.timeout_add
448
617
        return False
449
618
    
450
619
    def __del__(self):
451
620
        self.disable()
452
 
 
 
621
    
453
622
    def init_checker(self):
454
623
        # Schedule a new checker to be started an 'interval' from now,
455
624
        # and every interval from then on.
456
 
        self.checker_initiator_tag = (gobject.timeout_add
457
 
                                      (self.interval_milliseconds(),
458
 
                                       self.start_checker))
 
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)
459
630
        # Schedule a disable() when 'timeout' has passed
460
 
        self.disable_initiator_tag = (gobject.timeout_add
461
 
                                   (self.timeout_milliseconds(),
462
 
                                    self.disable))
 
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)
463
635
        # Also start a new checker *right now*.
464
636
        self.start_checker()
465
 
 
466
 
        
 
637
    
467
638
    def checker_callback(self, pid, condition, command):
468
639
        """The checker has completed, so take appropriate actions."""
469
640
        self.checker_callback_tag = None
470
641
        self.checker = None
471
642
        if os.WIFEXITED(condition):
472
 
            self.last_checker_status =  os.WEXITSTATUS(condition)
 
643
            self.last_checker_status = os.WEXITSTATUS(condition)
473
644
            if self.last_checker_status == 0:
474
645
                logger.info("Checker for %(name)s succeeded",
475
646
                            vars(self))
476
647
                self.checked_ok()
477
648
            else:
478
 
                logger.info("Checker for %(name)s failed",
479
 
                            vars(self))
 
649
                logger.info("Checker for %(name)s failed", vars(self))
480
650
        else:
481
651
            self.last_checker_status = -1
482
652
            logger.warning("Checker for %(name)s crashed?",
483
653
                           vars(self))
484
654
    
485
 
    def checked_ok(self, timeout=None):
486
 
        """Bump up the timeout for this client.
487
 
        
488
 
        This should only be called when the client has been seen,
489
 
        alive and well.
490
 
        """
 
655
    def checked_ok(self):
 
656
        """Assert that the client has been seen, alive and well."""
 
657
        self.last_checked_ok = datetime.datetime.utcnow()
 
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."""
491
663
        if timeout is None:
492
664
            timeout = self.timeout
493
 
        self.last_checked_ok = datetime.datetime.utcnow()
494
665
        if self.disable_initiator_tag is not None:
495
666
            gobject.source_remove(self.disable_initiator_tag)
 
667
            self.disable_initiator_tag = None
496
668
        if getattr(self, "enabled", False):
497
 
            self.disable_initiator_tag = (gobject.timeout_add
498
 
                                          (_timedelta_to_milliseconds
499
 
                                           (timeout), self.disable))
 
669
            self.disable_initiator_tag = gobject.timeout_add(
 
670
                int(timeout.total_seconds() * 1000), self.disable)
500
671
            self.expires = datetime.datetime.utcnow() + timeout
501
672
    
502
673
    def need_approval(self):
508
679
        If a checker already exists, leave it running and do
509
680
        nothing."""
510
681
        # The reason for not killing a running checker is that if we
511
 
        # did that, then if a checker (for some reason) started
512
 
        # running slowly and taking more than 'interval' time, the
513
 
        # client would inevitably timeout, since no checker would get
514
 
        # 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
515
686
        # checkers alone, the checker would have to take more time
516
687
        # than 'timeout' for the client to be disabled, which is as it
517
688
        # should be.
519
690
        # If a checker exists, make sure it is not a zombie
520
691
        try:
521
692
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
522
 
        except (AttributeError, OSError) as error:
523
 
            if (isinstance(error, OSError)
524
 
                and error.errno != errno.ECHILD):
525
 
                raise error
 
693
        except AttributeError:
 
694
            pass
 
695
        except OSError as error:
 
696
            if error.errno != errno.ECHILD:
 
697
                raise
526
698
        else:
527
699
            if pid:
528
700
                logger.warning("Checker was a zombie")
531
703
                                      self.current_checker_command)
532
704
        # Start a new checker if needed
533
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 }
534
710
            try:
535
 
                # In case checker_command has exactly one % operator
536
 
                command = self.checker_command % self.host
537
 
            except TypeError:
538
 
                # Escape attributes for the shell
539
 
                escaped_attrs = dict(
540
 
                    (attr,
541
 
                     re.escape(unicode(str(getattr(self, attr, "")),
542
 
                                       errors=
543
 
                                       'replace')))
544
 
                    for attr in
545
 
                    self.runtime_expansions)
546
 
                
547
 
                try:
548
 
                    command = self.checker_command % escaped_attrs
549
 
                except TypeError as error:
550
 
                    logger.error('Could not format string "%s":'
551
 
                                 ' %s', self.checker_command, error)
552
 
                    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
553
717
            self.current_checker_command = command
554
718
            try:
555
 
                logger.info("Starting checker %r for %s",
556
 
                            command, self.name)
 
719
                logger.info("Starting checker %r for %s", command,
 
720
                            self.name)
557
721
                # We don't need to redirect stdout and stderr, since
558
722
                # in normal mode, that is already done by daemon(),
559
723
                # and in debug mode we don't want to.  (Stdin is
560
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 })
561
733
                self.checker = subprocess.Popen(command,
562
734
                                                close_fds=True,
563
 
                                                shell=True, cwd="/")
564
 
                self.checker_callback_tag = (gobject.child_watch_add
565
 
                                             (self.checker.pid,
566
 
                                              self.checker_callback,
567
 
                                              data=command))
568
 
                # The checker may have completed before the gobject
569
 
                # 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:
570
747
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
571
 
                if pid:
572
 
                    gobject.source_remove(self.checker_callback_tag)
573
 
                    self.checker_callback(pid, status, command)
574
748
            except OSError as error:
575
 
                logger.error("Failed to start subprocess: %s",
576
 
                             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)
577
758
        # Re-run this periodically if run by gobject.timeout_add
578
759
        return True
579
760
    
586
767
            return
587
768
        logger.debug("Stopping checker for %(name)s", vars(self))
588
769
        try:
589
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
770
            self.checker.terminate()
590
771
            #time.sleep(0.5)
591
772
            #if self.checker.poll() is None:
592
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
773
            #    self.checker.kill()
593
774
        except OSError as error:
594
775
            if error.errno != errno.ESRCH: # No such process
595
776
                raise
596
777
        self.checker = None
597
778
 
598
 
    # Encrypts a client secret and stores it in a varible
599
 
    # encrypted_secret
600
 
    def encrypt_secret(self, key):
601
 
        # Encryption-key need to be of a specific size, so we hash
602
 
        # supplied key
603
 
        hasheng = hashlib.sha256()
604
 
        hasheng.update(key)
605
 
        encryptionkey = hasheng.digest()
606
 
 
607
 
        # Create validation hash so we know at decryption if it was
608
 
        # sucessful
609
 
        hasheng = hashlib.sha256()
610
 
        hasheng.update(self.secret)
611
 
        validationhash = hasheng.digest()
612
 
 
613
 
        # Encrypt secret
614
 
        iv = os.urandom(Crypto.Cipher.AES.block_size)
615
 
        ciphereng = Crypto.Cipher.AES.new(encryptionkey,
616
 
                                        Crypto.Cipher.AES.MODE_CFB, iv)
617
 
        ciphertext = ciphereng.encrypt(validationhash+self.secret)
618
 
        self.encrypted_secret = (ciphertext, iv)
619
 
 
620
 
    # Decrypt a encrypted client secret
621
 
    def decrypt_secret(self, key):
622
 
        # Decryption-key need to be of a specific size, so we hash
623
 
        # supplied key
624
 
        hasheng = hashlib.sha256()
625
 
        hasheng.update(key)
626
 
        encryptionkey = hasheng.digest()
627
 
 
628
 
        # Decrypt encrypted secret
629
 
        ciphertext, iv = self.encrypted_secret
630
 
        ciphereng = Crypto.Cipher.AES.new(encryptionkey,
631
 
                                        Crypto.Cipher.AES.MODE_CFB, iv)
632
 
        plain = ciphereng.decrypt(ciphertext)
633
 
 
634
 
        # Validate decrypted secret to know if it was succesful
635
 
        hasheng = hashlib.sha256()
636
 
        validationhash = plain[:hasheng.digest_size]
637
 
        secret = plain[hasheng.digest_size:]
638
 
        hasheng.update(secret)
639
 
 
640
 
        # If validation fails, we use key as new secret. Otherwise, we
641
 
        # use the decrypted secret
642
 
        if hasheng.digest() == validationhash:
643
 
            self.secret = secret
644
 
        else:
645
 
            self.secret = key
646
 
        del self.encrypted_secret
647
 
 
648
 
 
649
 
def dbus_service_property(dbus_interface, signature="v",
650
 
                          access="readwrite", byte_arrays=False):
 
779
 
 
780
def dbus_service_property(dbus_interface,
 
781
                          signature="v",
 
782
                          access="readwrite",
 
783
                          byte_arrays=False):
651
784
    """Decorators for marking methods of a DBusObjectWithProperties to
652
785
    become properties on the D-Bus.
653
786
    
662
795
    # "Set" method, so we fail early here:
663
796
    if byte_arrays and signature != "ay":
664
797
        raise ValueError("Byte arrays not supported for non-'ay'"
665
 
                         " signature %r" % signature)
 
798
                         " signature {!r}".format(signature))
 
799
    
666
800
    def decorator(func):
667
801
        func._dbus_is_property = True
668
802
        func._dbus_interface = dbus_interface
673
807
            func._dbus_name = func._dbus_name[:-14]
674
808
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
675
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
    
676
852
    return decorator
677
853
 
678
854
 
679
855
class DBusPropertyException(dbus.exceptions.DBusException):
680
856
    """A base class for D-Bus property-related exceptions
681
857
    """
682
 
    def __unicode__(self):
683
 
        return unicode(str(self))
 
858
    pass
684
859
 
685
860
 
686
861
class DBusPropertyAccessException(DBusPropertyException):
704
879
    """
705
880
    
706
881
    @staticmethod
707
 
    def _is_dbus_property(obj):
708
 
        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)
709
890
    
710
 
    def _get_all_dbus_properties(self):
 
891
    def _get_all_dbus_things(self, thing):
711
892
        """Returns a generator of (name, attribute) pairs
712
893
        """
713
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
894
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
895
                 athing.__get__(self))
714
896
                for cls in self.__class__.__mro__
715
 
                for name, prop in
716
 
                inspect.getmembers(cls, self._is_dbus_property))
 
897
                for name, athing in
 
898
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
717
899
    
718
900
    def _get_dbus_property(self, interface_name, property_name):
719
901
        """Returns a bound method if one exists which is a D-Bus
720
902
        property with the specified name and interface.
721
903
        """
722
 
        for cls in  self.__class__.__mro__:
723
 
            for name, value in (inspect.getmembers
724
 
                                (cls, self._is_dbus_property)):
 
904
        for cls in self.__class__.__mro__:
 
905
            for name, value in inspect.getmembers(
 
906
                    cls, self._is_dbus_thing("property")):
725
907
                if (value._dbus_name == property_name
726
908
                    and value._dbus_interface == interface_name):
727
909
                    return value.__get__(self)
728
910
        
729
911
        # No such property
730
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
731
 
                                   + interface_name + "."
732
 
                                   + property_name)
 
912
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
913
            self.dbus_object_path, interface_name, property_name))
733
914
    
734
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
915
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
916
                         in_signature="ss",
735
917
                         out_signature="v")
736
918
    def Get(self, interface_name, property_name):
737
919
        """Standard D-Bus property Get() method, see D-Bus standard.
755
937
            # The byte_arrays option is not supported yet on
756
938
            # signatures other than "ay".
757
939
            if prop._dbus_signature != "ay":
758
 
                raise ValueError
759
 
            value = dbus.ByteArray(''.join(unichr(byte)
760
 
                                           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))
761
945
        prop(value)
762
946
    
763
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
947
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
948
                         in_signature="s",
764
949
                         out_signature="a{sv}")
765
950
    def GetAll(self, interface_name):
766
951
        """Standard D-Bus property GetAll() method, see D-Bus
768
953
        
769
954
        Note: Will not include properties with access="write".
770
955
        """
771
 
        all = {}
772
 
        for name, prop in self._get_all_dbus_properties():
 
956
        properties = {}
 
957
        for name, prop in self._get_all_dbus_things("property"):
773
958
            if (interface_name
774
959
                and interface_name != prop._dbus_interface):
775
960
                # Interface non-empty but did not match
779
964
                continue
780
965
            value = prop()
781
966
            if not hasattr(value, "variant_level"):
782
 
                all[name] = value
 
967
                properties[name] = value
783
968
                continue
784
 
            all[name] = type(value)(value, variant_level=
785
 
                                    value.variant_level+1)
786
 
        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
787
980
    
788
981
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
789
982
                         out_signature="s",
790
983
                         path_keyword='object_path',
791
984
                         connection_keyword='connection')
792
985
    def Introspect(self, object_path, connection):
793
 
        """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.
794
989
        """
795
990
        xmlstring = dbus.service.Object.Introspect(self, object_path,
796
991
                                                   connection)
797
992
        try:
798
993
            document = xml.dom.minidom.parseString(xmlstring)
 
994
            
799
995
            def make_tag(document, name, prop):
800
996
                e = document.createElement("property")
801
997
                e.setAttribute("name", name)
802
998
                e.setAttribute("type", prop._dbus_signature)
803
999
                e.setAttribute("access", prop._dbus_access)
804
1000
                return e
 
1001
            
805
1002
            for if_tag in document.getElementsByTagName("interface"):
 
1003
                # Add property tags
806
1004
                for tag in (make_tag(document, name, prop)
807
1005
                            for name, prop
808
 
                            in self._get_all_dbus_properties()
 
1006
                            in self._get_all_dbus_things("property")
809
1007
                            if prop._dbus_interface
810
1008
                            == if_tag.getAttribute("name")):
811
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)
812
1039
                # Add the names to the return values for the
813
1040
                # "org.freedesktop.DBus.Properties" methods
814
1041
                if (if_tag.getAttribute("name")
829
1056
        except (AttributeError, xml.dom.DOMException,
830
1057
                xml.parsers.expat.ExpatError) as error:
831
1058
            logger.error("Failed to override Introspection method",
832
 
                         error)
 
1059
                         exc_info=error)
833
1060
        return xmlstring
834
1061
 
835
1062
 
836
 
def datetime_to_dbus (dt, variant_level=0):
 
1063
def datetime_to_dbus(dt, variant_level=0):
837
1064
    """Convert a UTC datetime.datetime() to a D-Bus type."""
838
1065
    if dt is None:
839
1066
        return dbus.String("", variant_level = variant_level)
840
 
    return dbus.String(dt.isoformat(),
841
 
                       variant_level=variant_level)
842
 
 
843
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
844
 
                                  .__metaclass__):
845
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
846
 
    will add additional D-Bus attributes matching a certain pattern.
 
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).
847
1092
    """
848
 
    def __new__(mcs, name, bases, attr):
849
 
        # Go through all the base classes which could have D-Bus
850
 
        # methods, signals, or properties in them
851
 
        for base in (b for b in bases
852
 
                     if issubclass(b, dbus.service.Object)):
853
 
            # Go though all attributes of the base class
854
 
            for attrname, attribute in inspect.getmembers(base):
 
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):
855
1101
                # Ignore non-D-Bus attributes, and D-Bus attributes
856
1102
                # with the wrong interface name
857
1103
                if (not hasattr(attribute, "_dbus_interface")
858
 
                    or not attribute._dbus_interface
859
 
                    .startswith("se.recompile.Mandos")):
 
1104
                    or not attribute._dbus_interface.startswith(
 
1105
                        orig_interface_name)):
860
1106
                    continue
861
1107
                # Create an alternate D-Bus interface name based on
862
1108
                # the current name
863
 
                alt_interface = (attribute._dbus_interface
864
 
                                 .replace("se.recompile.Mandos",
865
 
                                          "se.bsnet.fukt.Mandos"))
 
1109
                alt_interface = attribute._dbus_interface.replace(
 
1110
                    orig_interface_name, alt_interface_name)
 
1111
                interface_names.add(alt_interface)
866
1112
                # Is this a D-Bus signal?
867
1113
                if getattr(attribute, "_dbus_is_signal", False):
868
 
                    # Extract the original non-method function by
869
 
                    # black magic
 
1114
                    # Extract the original non-method undecorated
 
1115
                    # function by black magic
870
1116
                    nonmethod_func = (dict(
871
 
                            zip(attribute.func_code.co_freevars,
872
 
                                attribute.__closure__))["func"]
873
 
                                      .cell_contents)
 
1117
                        zip(attribute.func_code.co_freevars,
 
1118
                            attribute.__closure__))
 
1119
                                      ["func"].cell_contents)
874
1120
                    # Create a new, but exactly alike, function
875
1121
                    # object, and decorate it to be a new D-Bus signal
876
1122
                    # with the alternate D-Bus interface name
877
 
                    new_function = (dbus.service.signal
878
 
                                    (alt_interface,
879
 
                                     attribute._dbus_signature)
 
1123
                    new_function = (dbus.service.signal(
 
1124
                        alt_interface, attribute._dbus_signature)
880
1125
                                    (types.FunctionType(
881
 
                                nonmethod_func.func_code,
882
 
                                nonmethod_func.func_globals,
883
 
                                nonmethod_func.func_name,
884
 
                                nonmethod_func.func_defaults,
885
 
                                nonmethod_func.func_closure)))
 
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
886
1137
                    # Define a creator of a function to call both the
887
 
                    # old and new functions, so both the old and new
888
 
                    # signals gets sent when the function is called
 
1138
                    # original and alternate functions, so both the
 
1139
                    # original and alternate signals gets sent when
 
1140
                    # the function is called
889
1141
                    def fixscope(func1, func2):
890
1142
                        """This function is a scope container to pass
891
1143
                        func1 and func2 to the "call_both" function
892
1144
                        outside of its arguments"""
 
1145
                        
893
1146
                        def call_both(*args, **kwargs):
894
1147
                            """This function will emit two D-Bus
895
1148
                            signals by calling func1 and func2"""
896
1149
                            func1(*args, **kwargs)
897
1150
                            func2(*args, **kwargs)
 
1151
                        
898
1152
                        return call_both
899
1153
                    # Create the "call_both" function and add it to
900
1154
                    # the class
901
 
                    attr[attrname] = fixscope(attribute,
902
 
                                              new_function)
 
1155
                    attr[attrname] = fixscope(attribute, new_function)
903
1156
                # Is this a D-Bus method?
904
1157
                elif getattr(attribute, "_dbus_is_method", False):
905
1158
                    # Create a new, but exactly alike, function
906
1159
                    # object.  Decorate it to be a new D-Bus method
907
1160
                    # with the alternate D-Bus interface name.  Add it
908
1161
                    # to the class.
909
 
                    attr[attrname] = (dbus.service.method
910
 
                                      (alt_interface,
911
 
                                       attribute._dbus_in_signature,
912
 
                                       attribute._dbus_out_signature)
913
 
                                      (types.FunctionType
914
 
                                       (attribute.func_code,
915
 
                                        attribute.func_globals,
916
 
                                        attribute.func_name,
917
 
                                        attribute.func_defaults,
918
 
                                        attribute.func_closure)))
 
1162
                    attr[attrname] = (
 
1163
                        dbus.service.method(
 
1164
                            alt_interface,
 
1165
                            attribute._dbus_in_signature,
 
1166
                            attribute._dbus_out_signature)
 
1167
                        (types.FunctionType(attribute.func_code,
 
1168
                                            attribute.func_globals,
 
1169
                                            attribute.func_name,
 
1170
                                            attribute.func_defaults,
 
1171
                                            attribute.func_closure)))
 
1172
                    # Copy annotations, if any
 
1173
                    try:
 
1174
                        attr[attrname]._dbus_annotations = dict(
 
1175
                            attribute._dbus_annotations)
 
1176
                    except AttributeError:
 
1177
                        pass
919
1178
                # Is this a D-Bus property?
920
1179
                elif getattr(attribute, "_dbus_is_property", False):
921
1180
                    # Create a new, but exactly alike, function
922
1181
                    # object, and decorate it to be a new D-Bus
923
1182
                    # property with the alternate D-Bus interface
924
1183
                    # name.  Add it to the class.
925
 
                    attr[attrname] = (dbus_service_property
926
 
                                      (alt_interface,
927
 
                                       attribute._dbus_signature,
928
 
                                       attribute._dbus_access,
929
 
                                       attribute
930
 
                                       ._dbus_get_args_options
931
 
                                       ["byte_arrays"])
932
 
                                      (types.FunctionType
933
 
                                       (attribute.func_code,
934
 
                                        attribute.func_globals,
935
 
                                        attribute.func_name,
936
 
                                        attribute.func_defaults,
937
 
                                        attribute.func_closure)))
938
 
        return type.__new__(mcs, name, bases, attr)
939
 
 
 
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"})
940
1241
class ClientDBus(Client, DBusObjectWithProperties):
941
1242
    """A Client class using D-Bus
942
1243
    
946
1247
    """
947
1248
    
948
1249
    runtime_expansions = (Client.runtime_expansions
949
 
                          + ("dbus_object_path",))
 
1250
                          + ("dbus_object_path", ))
 
1251
    
 
1252
    _interface = "se.recompile.Mandos.Client"
950
1253
    
951
1254
    # dbus.service.Object doesn't use super(), so we can't either.
952
1255
    
953
1256
    def __init__(self, bus = None, *args, **kwargs):
954
1257
        self.bus = bus
955
 
        self._approvals_pending = 0
956
1258
        Client.__init__(self, *args, **kwargs)
957
 
        self.add_to_dbus()
958
 
    
959
 
    def add_to_dbus(self):
960
1259
        # Only now, when this client is initialized, can it show up on
961
1260
        # the D-Bus
962
 
        client_object_name = unicode(self.name).translate(
 
1261
        client_object_name = str(self.name).translate(
963
1262
            {ord("."): ord("_"),
964
1263
             ord("-"): ord("_")})
965
 
        self.dbus_object_path = (dbus.ObjectPath
966
 
                                 ("/clients/" + client_object_name))
 
1264
        self.dbus_object_path = dbus.ObjectPath(
 
1265
            "/clients/" + client_object_name)
967
1266
        DBusObjectWithProperties.__init__(self, self.bus,
968
1267
                                          self.dbus_object_path)
969
 
        
970
 
    def notifychangeproperty(transform_func,
971
 
                             dbus_name, type_func=lambda x: x,
972
 
                             variant_level=1):
 
1268
    
 
1269
    def notifychangeproperty(transform_func, dbus_name,
 
1270
                             type_func=lambda x: x,
 
1271
                             variant_level=1,
 
1272
                             invalidate_only=False,
 
1273
                             _interface=_interface):
973
1274
        """ Modify a variable so that it's a property which announces
974
1275
        its changes to DBus.
975
 
 
 
1276
        
976
1277
        transform_fun: Function that takes a value and a variant_level
977
1278
                       and transforms it to a D-Bus type.
978
1279
        dbus_name: D-Bus name of the variable
980
1281
                   to the D-Bus.  Default: no transform
981
1282
        variant_level: D-Bus variant level.  Default: 1
982
1283
        """
983
 
        attrname = "_{0}".format(dbus_name)
 
1284
        attrname = "_{}".format(dbus_name)
 
1285
        
984
1286
        def setter(self, value):
985
1287
            if hasattr(self, "dbus_object_path"):
986
1288
                if (not hasattr(self, attrname) or
987
1289
                    type_func(getattr(self, attrname, None))
988
1290
                    != type_func(value)):
989
 
                    dbus_value = transform_func(type_func(value),
990
 
                                                variant_level
991
 
                                                =variant_level)
992
 
                    self.PropertyChanged(dbus.String(dbus_name),
993
 
                                         dbus_value)
 
1291
                    if invalidate_only:
 
1292
                        self.PropertiesChanged(
 
1293
                            _interface, dbus.Dictionary(),
 
1294
                            dbus.Array((dbus_name, )))
 
1295
                    else:
 
1296
                        dbus_value = transform_func(
 
1297
                            type_func(value),
 
1298
                            variant_level = variant_level)
 
1299
                        self.PropertyChanged(dbus.String(dbus_name),
 
1300
                                             dbus_value)
 
1301
                        self.PropertiesChanged(
 
1302
                            _interface,
 
1303
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1304
                                              dbus_value }),
 
1305
                            dbus.Array())
994
1306
            setattr(self, attrname, value)
995
1307
        
996
1308
        return property(lambda self: getattr(self, attrname), setter)
997
1309
    
998
 
    
999
1310
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1000
1311
    approvals_pending = notifychangeproperty(dbus.Boolean,
1001
1312
                                             "ApprovalPending",
1003
1314
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1004
1315
    last_enabled = notifychangeproperty(datetime_to_dbus,
1005
1316
                                        "LastEnabled")
1006
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1007
 
                                   type_func = lambda checker:
1008
 
                                       checker is not None)
 
1317
    checker = notifychangeproperty(
 
1318
        dbus.Boolean, "CheckerRunning",
 
1319
        type_func = lambda checker: checker is not None)
1009
1320
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1010
1321
                                           "LastCheckedOK")
 
1322
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1323
                                               "LastCheckerStatus")
1011
1324
    last_approval_request = notifychangeproperty(
1012
1325
        datetime_to_dbus, "LastApprovalRequest")
1013
1326
    approved_by_default = notifychangeproperty(dbus.Boolean,
1014
1327
                                               "ApprovedByDefault")
1015
 
    approval_delay = notifychangeproperty(dbus.UInt16,
1016
 
                                          "ApprovalDelay",
1017
 
                                          type_func =
1018
 
                                          _timedelta_to_milliseconds)
 
1328
    approval_delay = notifychangeproperty(
 
1329
        dbus.UInt64, "ApprovalDelay",
 
1330
        type_func = lambda td: td.total_seconds() * 1000)
1019
1331
    approval_duration = notifychangeproperty(
1020
 
        dbus.UInt16, "ApprovalDuration",
1021
 
        type_func = _timedelta_to_milliseconds)
 
1332
        dbus.UInt64, "ApprovalDuration",
 
1333
        type_func = lambda td: td.total_seconds() * 1000)
1022
1334
    host = notifychangeproperty(dbus.String, "Host")
1023
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1024
 
                                   type_func =
1025
 
                                   _timedelta_to_milliseconds)
 
1335
    timeout = notifychangeproperty(
 
1336
        dbus.UInt64, "Timeout",
 
1337
        type_func = lambda td: td.total_seconds() * 1000)
1026
1338
    extended_timeout = notifychangeproperty(
1027
 
        dbus.UInt16, "ExtendedTimeout",
1028
 
        type_func = _timedelta_to_milliseconds)
1029
 
    interval = notifychangeproperty(dbus.UInt16,
1030
 
                                    "Interval",
1031
 
                                    type_func =
1032
 
                                    _timedelta_to_milliseconds)
 
1339
        dbus.UInt64, "ExtendedTimeout",
 
1340
        type_func = lambda td: td.total_seconds() * 1000)
 
1341
    interval = notifychangeproperty(
 
1342
        dbus.UInt64, "Interval",
 
1343
        type_func = lambda td: td.total_seconds() * 1000)
1033
1344
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1345
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1346
                                  invalidate_only=True)
1034
1347
    
1035
1348
    del notifychangeproperty
1036
1349
    
1063
1376
                                       *args, **kwargs)
1064
1377
    
1065
1378
    def start_checker(self, *args, **kwargs):
1066
 
        old_checker = self.checker
1067
 
        if self.checker is not None:
1068
 
            old_checker_pid = self.checker.pid
1069
 
        else:
1070
 
            old_checker_pid = None
 
1379
        old_checker_pid = getattr(self.checker, "pid", None)
1071
1380
        r = Client.start_checker(self, *args, **kwargs)
1072
1381
        # Only if new checker process was started
1073
1382
        if (self.checker is not None
1077
1386
        return r
1078
1387
    
1079
1388
    def _reset_approved(self):
1080
 
        self._approved = None
 
1389
        self.approved = None
1081
1390
        return False
1082
1391
    
1083
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)
1084
1396
        self.send_changedstate()
1085
 
        self._approved = value
1086
 
        gobject.timeout_add(_timedelta_to_milliseconds
1087
 
                            (self.approval_duration),
1088
 
                            self._reset_approved)
1089
 
    
1090
1397
    
1091
1398
    ## D-Bus methods, signals & properties
1092
 
    _interface = "se.recompile.Mandos.Client"
 
1399
    
 
1400
    ## Interfaces
1093
1401
    
1094
1402
    ## Signals
1095
1403
    
1106
1414
        pass
1107
1415
    
1108
1416
    # PropertyChanged - signal
 
1417
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1109
1418
    @dbus.service.signal(_interface, signature="sv")
1110
1419
    def PropertyChanged(self, property, value):
1111
1420
        "D-Bus signal"
1175
1484
        return dbus.Boolean(bool(self.approvals_pending))
1176
1485
    
1177
1486
    # ApprovedByDefault - property
1178
 
    @dbus_service_property(_interface, signature="b",
 
1487
    @dbus_service_property(_interface,
 
1488
                           signature="b",
1179
1489
                           access="readwrite")
1180
1490
    def ApprovedByDefault_dbus_property(self, value=None):
1181
1491
        if value is None:       # get
1183
1493
        self.approved_by_default = bool(value)
1184
1494
    
1185
1495
    # ApprovalDelay - property
1186
 
    @dbus_service_property(_interface, signature="t",
 
1496
    @dbus_service_property(_interface,
 
1497
                           signature="t",
1187
1498
                           access="readwrite")
1188
1499
    def ApprovalDelay_dbus_property(self, value=None):
1189
1500
        if value is None:       # get
1190
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1501
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1502
                               * 1000)
1191
1503
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1192
1504
    
1193
1505
    # ApprovalDuration - property
1194
 
    @dbus_service_property(_interface, signature="t",
 
1506
    @dbus_service_property(_interface,
 
1507
                           signature="t",
1195
1508
                           access="readwrite")
1196
1509
    def ApprovalDuration_dbus_property(self, value=None):
1197
1510
        if value is None:       # get
1198
 
            return dbus.UInt64(_timedelta_to_milliseconds(
1199
 
                    self.approval_duration))
 
1511
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1512
                               * 1000)
1200
1513
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1201
1514
    
1202
1515
    # Name - property
1210
1523
        return dbus.String(self.fingerprint)
1211
1524
    
1212
1525
    # Host - property
1213
 
    @dbus_service_property(_interface, signature="s",
 
1526
    @dbus_service_property(_interface,
 
1527
                           signature="s",
1214
1528
                           access="readwrite")
1215
1529
    def Host_dbus_property(self, value=None):
1216
1530
        if value is None:       # get
1217
1531
            return dbus.String(self.host)
1218
 
        self.host = value
 
1532
        self.host = str(value)
1219
1533
    
1220
1534
    # Created - property
1221
1535
    @dbus_service_property(_interface, signature="s", access="read")
1222
1536
    def Created_dbus_property(self):
1223
 
        return dbus.String(datetime_to_dbus(self.created))
 
1537
        return datetime_to_dbus(self.created)
1224
1538
    
1225
1539
    # LastEnabled - property
1226
1540
    @dbus_service_property(_interface, signature="s", access="read")
1228
1542
        return datetime_to_dbus(self.last_enabled)
1229
1543
    
1230
1544
    # Enabled - property
1231
 
    @dbus_service_property(_interface, signature="b",
 
1545
    @dbus_service_property(_interface,
 
1546
                           signature="b",
1232
1547
                           access="readwrite")
1233
1548
    def Enabled_dbus_property(self, value=None):
1234
1549
        if value is None:       # get
1239
1554
            self.disable()
1240
1555
    
1241
1556
    # LastCheckedOK - property
1242
 
    @dbus_service_property(_interface, signature="s",
 
1557
    @dbus_service_property(_interface,
 
1558
                           signature="s",
1243
1559
                           access="readwrite")
1244
1560
    def LastCheckedOK_dbus_property(self, value=None):
1245
1561
        if value is not None:
1247
1563
            return
1248
1564
        return datetime_to_dbus(self.last_checked_ok)
1249
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
    
1250
1571
    # Expires - property
1251
1572
    @dbus_service_property(_interface, signature="s", access="read")
1252
1573
    def Expires_dbus_property(self):
1258
1579
        return datetime_to_dbus(self.last_approval_request)
1259
1580
    
1260
1581
    # Timeout - property
1261
 
    @dbus_service_property(_interface, signature="t",
 
1582
    @dbus_service_property(_interface,
 
1583
                           signature="t",
1262
1584
                           access="readwrite")
1263
1585
    def Timeout_dbus_property(self, value=None):
1264
1586
        if value is None:       # get
1265
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1587
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1588
        old_timeout = self.timeout
1266
1589
        self.timeout = datetime.timedelta(0, 0, 0, value)
1267
 
        if getattr(self, "disable_initiator_tag", None) is None:
1268
 
            return
1269
 
        # Reschedule timeout
1270
 
        gobject.source_remove(self.disable_initiator_tag)
1271
 
        self.disable_initiator_tag = None
1272
 
        self.expires = None
1273
 
        time_to_die = _timedelta_to_milliseconds((self
1274
 
                                                  .last_checked_ok
1275
 
                                                  + self.timeout)
1276
 
                                                 - datetime.datetime
1277
 
                                                 .utcnow())
1278
 
        if time_to_die <= 0:
1279
 
            # The timeout has passed
1280
 
            self.disable()
1281
 
        else:
1282
 
            self.expires = (datetime.datetime.utcnow()
1283
 
                            + datetime.timedelta(milliseconds =
1284
 
                                                 time_to_die))
1285
 
            self.disable_initiator_tag = (gobject.timeout_add
1286
 
                                          (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)
1287
1605
    
1288
1606
    # ExtendedTimeout - property
1289
 
    @dbus_service_property(_interface, signature="t",
 
1607
    @dbus_service_property(_interface,
 
1608
                           signature="t",
1290
1609
                           access="readwrite")
1291
1610
    def ExtendedTimeout_dbus_property(self, value=None):
1292
1611
        if value is None:       # get
1293
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1612
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1613
                               * 1000)
1294
1614
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1295
1615
    
1296
1616
    # Interval - property
1297
 
    @dbus_service_property(_interface, signature="t",
 
1617
    @dbus_service_property(_interface,
 
1618
                           signature="t",
1298
1619
                           access="readwrite")
1299
1620
    def Interval_dbus_property(self, value=None):
1300
1621
        if value is None:       # get
1301
 
            return dbus.UInt64(self.interval_milliseconds())
 
1622
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1302
1623
        self.interval = datetime.timedelta(0, 0, 0, value)
1303
1624
        if getattr(self, "checker_initiator_tag", None) is None:
1304
1625
            return
1305
 
        # Reschedule checker run
1306
 
        gobject.source_remove(self.checker_initiator_tag)
1307
 
        self.checker_initiator_tag = (gobject.timeout_add
1308
 
                                      (value, self.start_checker))
1309
 
        self.start_checker()    # Start one now, too
 
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
1310
1632
    
1311
1633
    # Checker - property
1312
 
    @dbus_service_property(_interface, signature="s",
 
1634
    @dbus_service_property(_interface,
 
1635
                           signature="s",
1313
1636
                           access="readwrite")
1314
1637
    def Checker_dbus_property(self, value=None):
1315
1638
        if value is None:       # get
1316
1639
            return dbus.String(self.checker_command)
1317
 
        self.checker_command = value
 
1640
        self.checker_command = str(value)
1318
1641
    
1319
1642
    # CheckerRunning - property
1320
 
    @dbus_service_property(_interface, signature="b",
 
1643
    @dbus_service_property(_interface,
 
1644
                           signature="b",
1321
1645
                           access="readwrite")
1322
1646
    def CheckerRunning_dbus_property(self, value=None):
1323
1647
        if value is None:       # get
1333
1657
        return self.dbus_object_path # is already a dbus.ObjectPath
1334
1658
    
1335
1659
    # Secret = property
1336
 
    @dbus_service_property(_interface, signature="ay",
1337
 
                           access="write", byte_arrays=True)
 
1660
    @dbus_service_property(_interface,
 
1661
                           signature="ay",
 
1662
                           access="write",
 
1663
                           byte_arrays=True)
1338
1664
    def Secret_dbus_property(self, value):
1339
 
        self.secret = str(value)
 
1665
        self.secret = bytes(value)
1340
1666
    
1341
1667
    del _interface
1342
1668
 
1346
1672
        self._pipe = child_pipe
1347
1673
        self._pipe.send(('init', fpr, address))
1348
1674
        if not self._pipe.recv():
1349
 
            raise KeyError()
 
1675
            raise KeyError(fpr)
1350
1676
    
1351
1677
    def __getattribute__(self, name):
1352
 
        if(name == '_pipe'):
 
1678
        if name == '_pipe':
1353
1679
            return super(ProxyClient, self).__getattribute__(name)
1354
1680
        self._pipe.send(('getattr', name))
1355
1681
        data = self._pipe.recv()
1356
1682
        if data[0] == 'data':
1357
1683
            return data[1]
1358
1684
        if data[0] == 'function':
 
1685
            
1359
1686
            def func(*args, **kwargs):
1360
1687
                self._pipe.send(('funcall', name, args, kwargs))
1361
1688
                return self._pipe.recv()[1]
 
1689
            
1362
1690
            return func
1363
1691
    
1364
1692
    def __setattr__(self, name, value):
1365
 
        if(name == '_pipe'):
 
1693
        if name == '_pipe':
1366
1694
            return super(ProxyClient, self).__setattr__(name, value)
1367
1695
        self._pipe.send(('setattr', name, value))
1368
1696
 
1369
 
class ClientDBusTransitional(ClientDBus):
1370
 
    __metaclass__ = AlternateDBusNamesMetaclass
1371
1697
 
1372
1698
class ClientHandler(socketserver.BaseRequestHandler, object):
1373
1699
    """A class to handle client connections.
1378
1704
    def handle(self):
1379
1705
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1380
1706
            logger.info("TCP connection from: %s",
1381
 
                        unicode(self.client_address))
 
1707
                        str(self.client_address))
1382
1708
            logger.debug("Pipe FD: %d",
1383
1709
                         self.server.child_pipe.fileno())
1384
1710
            
1385
 
            session = (gnutls.connection
1386
 
                       .ClientSession(self.request,
1387
 
                                      gnutls.connection
1388
 
                                      .X509Credentials()))
 
1711
            session = gnutls.connection.ClientSession(
 
1712
                self.request, gnutls.connection .X509Credentials())
1389
1713
            
1390
1714
            # Note: gnutls.connection.X509Credentials is really a
1391
1715
            # generic GnuTLS certificate credentials object so long as
1400
1724
            priority = self.server.gnutls_priority
1401
1725
            if priority is None:
1402
1726
                priority = "NORMAL"
1403
 
            (gnutls.library.functions
1404
 
             .gnutls_priority_set_direct(session._c_object,
1405
 
                                         priority, None))
 
1727
            gnutls.library.functions.gnutls_priority_set_direct(
 
1728
                session._c_object, priority, None)
1406
1729
            
1407
1730
            # Start communication using the Mandos protocol
1408
1731
            # Get protocol number
1410
1733
            logger.debug("Protocol version: %r", line)
1411
1734
            try:
1412
1735
                if int(line.strip().split()[0]) > 1:
1413
 
                    raise RuntimeError
 
1736
                    raise RuntimeError(line)
1414
1737
            except (ValueError, IndexError, RuntimeError) as error:
1415
1738
                logger.error("Unknown protocol version: %s", error)
1416
1739
                return
1428
1751
            approval_required = False
1429
1752
            try:
1430
1753
                try:
1431
 
                    fpr = self.fingerprint(self.peer_certificate
1432
 
                                           (session))
 
1754
                    fpr = self.fingerprint(
 
1755
                        self.peer_certificate(session))
1433
1756
                except (TypeError,
1434
1757
                        gnutls.errors.GNUTLSError) as error:
1435
1758
                    logger.warning("Bad certificate: %s", error)
1450
1773
                while True:
1451
1774
                    if not client.enabled:
1452
1775
                        logger.info("Client %s is disabled",
1453
 
                                       client.name)
 
1776
                                    client.name)
1454
1777
                        if self.server.use_dbus:
1455
1778
                            # Emit D-Bus signal
1456
1779
                            client.Rejected("Disabled")
1457
1780
                        return
1458
1781
                    
1459
 
                    if client._approved or not client.approval_delay:
 
1782
                    if client.approved or not client.approval_delay:
1460
1783
                        #We are approved or approval is disabled
1461
1784
                        break
1462
 
                    elif client._approved is None:
 
1785
                    elif client.approved is None:
1463
1786
                        logger.info("Client %s needs approval",
1464
1787
                                    client.name)
1465
1788
                        if self.server.use_dbus:
1466
1789
                            # Emit D-Bus signal
1467
1790
                            client.NeedApproval(
1468
 
                                client.approval_delay_milliseconds(),
1469
 
                                client.approved_by_default)
 
1791
                                client.approval_delay.total_seconds()
 
1792
                                * 1000, client.approved_by_default)
1470
1793
                    else:
1471
1794
                        logger.warning("Client %s was not approved",
1472
1795
                                       client.name)
1478
1801
                    #wait until timeout or approved
1479
1802
                    time = datetime.datetime.now()
1480
1803
                    client.changedstate.acquire()
1481
 
                    (client.changedstate.wait
1482
 
                     (float(client._timedelta_to_milliseconds(delay)
1483
 
                            / 1000)))
 
1804
                    client.changedstate.wait(delay.total_seconds())
1484
1805
                    client.changedstate.release()
1485
1806
                    time2 = datetime.datetime.now()
1486
1807
                    if (time2 - time) >= delay:
1502
1823
                    try:
1503
1824
                        sent = session.send(client.secret[sent_size:])
1504
1825
                    except gnutls.errors.GNUTLSError as error:
1505
 
                        logger.warning("gnutls send failed")
 
1826
                        logger.warning("gnutls send failed",
 
1827
                                       exc_info=error)
1506
1828
                        return
1507
 
                    logger.debug("Sent: %d, remaining: %d",
1508
 
                                 sent, len(client.secret)
1509
 
                                 - (sent_size + sent))
 
1829
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1830
                                 len(client.secret) - (sent_size
 
1831
                                                       + sent))
1510
1832
                    sent_size += sent
1511
1833
                
1512
1834
                logger.info("Sending secret to %s", client.name)
1513
1835
                # bump the timeout using extended_timeout
1514
 
                client.checked_ok(client.extended_timeout)
 
1836
                client.bump_timeout(client.extended_timeout)
1515
1837
                if self.server.use_dbus:
1516
1838
                    # Emit D-Bus signal
1517
1839
                    client.GotSecret()
1522
1844
                try:
1523
1845
                    session.bye()
1524
1846
                except gnutls.errors.GNUTLSError as error:
1525
 
                    logger.warning("GnuTLS bye failed")
 
1847
                    logger.warning("GnuTLS bye failed",
 
1848
                                   exc_info=error)
1526
1849
    
1527
1850
    @staticmethod
1528
1851
    def peer_certificate(session):
1529
1852
        "Return the peer's OpenPGP certificate as a bytestring"
1530
1853
        # If not an OpenPGP certificate...
1531
 
        if (gnutls.library.functions
1532
 
            .gnutls_certificate_type_get(session._c_object)
 
1854
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
1855
                session._c_object)
1533
1856
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1534
1857
            # ...do the normal thing
1535
1858
            return session.peer_certificate
1549
1872
    def fingerprint(openpgp):
1550
1873
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1551
1874
        # New GnuTLS "datum" with the OpenPGP public key
1552
 
        datum = (gnutls.library.types
1553
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1554
 
                                             ctypes.POINTER
1555
 
                                             (ctypes.c_ubyte)),
1556
 
                                 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)))
1557
1879
        # New empty GnuTLS certificate
1558
1880
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1559
 
        (gnutls.library.functions
1560
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
1881
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
1882
            ctypes.byref(crt))
1561
1883
        # Import the OpenPGP public key into the certificate
1562
 
        (gnutls.library.functions
1563
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1564
 
                                    gnutls.library.constants
1565
 
                                    .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)
1566
1887
        # Verify the self signature in the key
1567
1888
        crtverify = ctypes.c_uint()
1568
 
        (gnutls.library.functions
1569
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1570
 
                                         ctypes.byref(crtverify)))
 
1889
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
1890
            crt, 0, ctypes.byref(crtverify))
1571
1891
        if crtverify.value != 0:
1572
1892
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1573
 
            raise (gnutls.errors.CertificateSecurityError
1574
 
                   ("Verify failed"))
 
1893
            raise gnutls.errors.CertificateSecurityError(
 
1894
                "Verify failed")
1575
1895
        # New buffer for the fingerprint
1576
1896
        buf = ctypes.create_string_buffer(20)
1577
1897
        buf_len = ctypes.c_size_t()
1578
1898
        # Get the fingerprint from the certificate into the buffer
1579
 
        (gnutls.library.functions
1580
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1581
 
                                             ctypes.byref(buf_len)))
 
1899
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
1900
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1582
1901
        # Deinit the certificate
1583
1902
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1584
1903
        # Convert the buffer to a Python bytestring
1585
1904
        fpr = ctypes.string_at(buf, buf_len.value)
1586
1905
        # Convert the bytestring to hexadecimal notation
1587
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1906
        hex_fpr = binascii.hexlify(fpr).upper()
1588
1907
        return hex_fpr
1589
1908
 
1590
1909
 
1591
1910
class MultiprocessingMixIn(object):
1592
1911
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1912
    
1593
1913
    def sub_process_main(self, request, address):
1594
1914
        try:
1595
1915
            self.finish_request(request, address)
1596
 
        except:
 
1916
        except Exception:
1597
1917
            self.handle_error(request, address)
1598
1918
        self.close_request(request)
1599
1919
    
1600
1920
    def process_request(self, request, address):
1601
1921
        """Start a new process to process the request."""
1602
1922
        proc = multiprocessing.Process(target = self.sub_process_main,
1603
 
                                       args = (request,
1604
 
                                               address))
 
1923
                                       args = (request, address))
1605
1924
        proc.start()
1606
1925
        return proc
1607
1926
 
1608
1927
 
1609
1928
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1610
1929
    """ adds a pipe to the MixIn """
 
1930
    
1611
1931
    def process_request(self, request, client_address):
1612
1932
        """Overrides and wraps the original process_request().
1613
1933
        
1622
1942
    
1623
1943
    def add_pipe(self, parent_pipe, proc):
1624
1944
        """Dummy function; override as necessary"""
1625
 
        raise NotImplementedError
 
1945
        raise NotImplementedError()
1626
1946
 
1627
1947
 
1628
1948
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1634
1954
        interface:      None or a network interface name (string)
1635
1955
        use_ipv6:       Boolean; to use IPv6 or not
1636
1956
    """
 
1957
    
1637
1958
    def __init__(self, server_address, RequestHandlerClass,
1638
 
                 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
        """
1639
1965
        self.interface = interface
1640
1966
        if use_ipv6:
1641
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.
1642
1994
        socketserver.TCPServer.__init__(self, server_address,
1643
1995
                                        RequestHandlerClass)
 
1996
    
1644
1997
    def server_bind(self):
1645
1998
        """This overrides the normal server_bind() function
1646
1999
        to bind to an interface if one was specified, and also NOT to
1652
2005
                             self.interface)
1653
2006
            else:
1654
2007
                try:
1655
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1656
 
                                           SO_BINDTODEVICE,
1657
 
                                           str(self.interface
1658
 
                                               + '\0'))
 
2008
                    self.socket.setsockopt(
 
2009
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2010
                        (self.interface + "\0").encode("utf-8"))
1659
2011
                except socket.error as error:
1660
 
                    if error[0] == errno.EPERM:
1661
 
                        logger.error("No permission to"
1662
 
                                     " bind to interface %s",
1663
 
                                     self.interface)
1664
 
                    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:
1665
2016
                        logger.error("SO_BINDTODEVICE not available;"
1666
2017
                                     " cannot bind to interface %s",
1667
2018
                                     self.interface)
 
2019
                    elif error.errno == errno.ENODEV:
 
2020
                        logger.error("Interface %s does not exist,"
 
2021
                                     " cannot bind", self.interface)
1668
2022
                    else:
1669
2023
                        raise
1670
2024
        # Only bind(2) the socket if we really need to.
1673
2027
                if self.address_family == socket.AF_INET6:
1674
2028
                    any_address = "::" # in6addr_any
1675
2029
                else:
1676
 
                    any_address = socket.INADDR_ANY
 
2030
                    any_address = "0.0.0.0" # INADDR_ANY
1677
2031
                self.server_address = (any_address,
1678
2032
                                       self.server_address[1])
1679
2033
            elif not self.server_address[1]:
1680
 
                self.server_address = (self.server_address[0],
1681
 
                                       0)
 
2034
                self.server_address = (self.server_address[0], 0)
1682
2035
#                 if self.interface:
1683
2036
#                     self.server_address = (self.server_address[0],
1684
2037
#                                            0, # port
1698
2051
    
1699
2052
    Assumes a gobject.MainLoop event loop.
1700
2053
    """
 
2054
    
1701
2055
    def __init__(self, server_address, RequestHandlerClass,
1702
 
                 interface=None, use_ipv6=True, clients=None,
1703
 
                 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):
1704
2062
        self.enabled = False
1705
2063
        self.clients = clients
1706
2064
        if self.clients is None:
1710
2068
        IPv6_TCPServer.__init__(self, server_address,
1711
2069
                                RequestHandlerClass,
1712
2070
                                interface = interface,
1713
 
                                use_ipv6 = use_ipv6)
 
2071
                                use_ipv6 = use_ipv6,
 
2072
                                socketfd = socketfd)
 
2073
    
1714
2074
    def server_activate(self):
1715
2075
        if self.enabled:
1716
2076
            return socketserver.TCPServer.server_activate(self)
1720
2080
    
1721
2081
    def add_pipe(self, parent_pipe, proc):
1722
2082
        # Call "handle_ipc" for both data and EOF events
1723
 
        gobject.io_add_watch(parent_pipe.fileno(),
1724
 
                             gobject.IO_IN | gobject.IO_HUP,
1725
 
                             functools.partial(self.handle_ipc,
1726
 
                                               parent_pipe =
1727
 
                                               parent_pipe,
1728
 
                                               proc = proc))
 
2083
        gobject.io_add_watch(
 
2084
            parent_pipe.fileno(),
 
2085
            gobject.IO_IN | gobject.IO_HUP,
 
2086
            functools.partial(self.handle_ipc,
 
2087
                              parent_pipe = parent_pipe,
 
2088
                              proc = proc))
1729
2089
    
1730
 
    def handle_ipc(self, source, condition, parent_pipe=None,
1731
 
                   proc = None, client_object=None):
1732
 
        condition_names = {
1733
 
            gobject.IO_IN: "IN",   # There is data to read.
1734
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1735
 
                                    # blocking).
1736
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1737
 
            gobject.IO_ERR: "ERR", # Error condition.
1738
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1739
 
                                    # broken, usually for pipes and
1740
 
                                    # sockets).
1741
 
            }
1742
 
        conditions_string = ' | '.join(name
1743
 
                                       for cond, name in
1744
 
                                       condition_names.iteritems()
1745
 
                                       if cond & condition)
 
2090
    def handle_ipc(self, source, condition,
 
2091
                   parent_pipe=None,
 
2092
                   proc = None,
 
2093
                   client_object=None):
1746
2094
        # error, or the other end of multiprocessing.Pipe has closed
1747
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2095
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1748
2096
            # Wait for other process to exit
1749
2097
            proc.join()
1750
2098
            return False
1771
2119
                parent_pipe.send(False)
1772
2120
                return False
1773
2121
            
1774
 
            gobject.io_add_watch(parent_pipe.fileno(),
1775
 
                                 gobject.IO_IN | gobject.IO_HUP,
1776
 
                                 functools.partial(self.handle_ipc,
1777
 
                                                   parent_pipe =
1778
 
                                                   parent_pipe,
1779
 
                                                   proc = proc,
1780
 
                                                   client_object =
1781
 
                                                   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))
1782
2129
            parent_pipe.send(True)
1783
2130
            # remove the old hook in favor of the new above hook on
1784
2131
            # same fileno
1790
2137
            
1791
2138
            parent_pipe.send(('data', getattr(client_object,
1792
2139
                                              funcname)(*args,
1793
 
                                                         **kwargs)))
 
2140
                                                        **kwargs)))
1794
2141
        
1795
2142
        if command == 'getattr':
1796
2143
            attrname = request[1]
1797
2144
            if callable(client_object.__getattribute__(attrname)):
1798
 
                parent_pipe.send(('function',))
 
2145
                parent_pipe.send(('function', ))
1799
2146
            else:
1800
 
                parent_pipe.send(('data', client_object
1801
 
                                  .__getattribute__(attrname)))
 
2147
                parent_pipe.send((
 
2148
                    'data', client_object.__getattribute__(attrname)))
1802
2149
        
1803
2150
        if command == 'setattr':
1804
2151
            attrname = request[1]
1808
2155
        return True
1809
2156
 
1810
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
 
1811
2263
def string_to_delta(interval):
1812
2264
    """Parse a string and return a datetime.timedelta
1813
2265
    
1824
2276
    >>> string_to_delta('5m 30s')
1825
2277
    datetime.timedelta(0, 330)
1826
2278
    """
 
2279
    
 
2280
    try:
 
2281
        return rfc3339_duration_to_delta(interval)
 
2282
    except ValueError:
 
2283
        pass
 
2284
    
1827
2285
    timevalue = datetime.timedelta(0)
1828
2286
    for s in interval.split():
1829
2287
        try:
1830
 
            suffix = unicode(s[-1])
 
2288
            suffix = s[-1]
1831
2289
            value = int(s[:-1])
1832
2290
            if suffix == "d":
1833
2291
                delta = datetime.timedelta(value)
1840
2298
            elif suffix == "w":
1841
2299
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1842
2300
            else:
1843
 
                raise ValueError("Unknown suffix %r" % suffix)
1844
 
        except (ValueError, IndexError) as e:
 
2301
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2302
        except IndexError as e:
1845
2303
            raise ValueError(*(e.args))
1846
2304
        timevalue += delta
1847
2305
    return timevalue
1848
2306
 
1849
2307
 
1850
 
def if_nametoindex(interface):
1851
 
    """Call the C function if_nametoindex(), or equivalent
1852
 
    
1853
 
    Note: This function cannot accept a unicode string."""
1854
 
    global if_nametoindex
1855
 
    try:
1856
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1857
 
                          (ctypes.util.find_library("c"))
1858
 
                          .if_nametoindex)
1859
 
    except (OSError, AttributeError):
1860
 
        logger.warning("Doing if_nametoindex the hard way")
1861
 
        def if_nametoindex(interface):
1862
 
            "Get an interface index the hard way, i.e. using fcntl()"
1863
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1864
 
            with contextlib.closing(socket.socket()) as s:
1865
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1866
 
                                    struct.pack(str("16s16x"),
1867
 
                                                interface))
1868
 
            interface_index = struct.unpack(str("I"),
1869
 
                                            ifreq[16:20])[0]
1870
 
            return interface_index
1871
 
    return if_nametoindex(interface)
1872
 
 
1873
 
 
1874
2308
def daemon(nochdir = False, noclose = False):
1875
2309
    """See daemon(3).  Standard BSD Unix function.
1876
2310
    
1884
2318
        sys.exit()
1885
2319
    if not noclose:
1886
2320
        # Close all standard open file descriptors
1887
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2321
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1888
2322
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1889
2323
            raise OSError(errno.ENODEV,
1890
 
                          "%s not a character device"
1891
 
                          % os.path.devnull)
 
2324
                          "{} not a character device"
 
2325
                          .format(os.devnull))
1892
2326
        os.dup2(null, sys.stdin.fileno())
1893
2327
        os.dup2(null, sys.stdout.fileno())
1894
2328
        os.dup2(null, sys.stderr.fileno())
1903
2337
    
1904
2338
    parser = argparse.ArgumentParser()
1905
2339
    parser.add_argument("-v", "--version", action="version",
1906
 
                        version = "%%(prog)s %s" % version,
 
2340
                        version = "%(prog)s {}".format(version),
1907
2341
                        help="show version number and exit")
1908
2342
    parser.add_argument("-i", "--interface", metavar="IF",
1909
2343
                        help="Bind to interface IF")
1915
2349
                        help="Run self-test")
1916
2350
    parser.add_argument("--debug", action="store_true",
1917
2351
                        help="Debug mode; run in foreground and log"
1918
 
                        " to terminal")
 
2352
                        " to terminal", default=None)
1919
2353
    parser.add_argument("--debuglevel", metavar="LEVEL",
1920
2354
                        help="Debug level for stdout output")
1921
2355
    parser.add_argument("--priority", help="GnuTLS"
1928
2362
                        " files")
1929
2363
    parser.add_argument("--no-dbus", action="store_false",
1930
2364
                        dest="use_dbus", help="Do not provide D-Bus"
1931
 
                        " system bus interface")
 
2365
                        " system bus interface", default=None)
1932
2366
    parser.add_argument("--no-ipv6", action="store_false",
1933
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2367
                        dest="use_ipv6", help="Do not use IPv6",
 
2368
                        default=None)
1934
2369
    parser.add_argument("--no-restore", action="store_false",
1935
 
                        dest="restore",
1936
 
                        help="Do not restore stored state",
1937
 
                        default=True)
1938
 
 
 
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
    
1939
2383
    options = parser.parse_args()
1940
2384
    
1941
2385
    if options.check:
1942
2386
        import doctest
1943
 
        doctest.testmod()
1944
 
        sys.exit()
 
2387
        fail_count, test_count = doctest.testmod()
 
2388
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1945
2389
    
1946
2390
    # Default values for config file for server-global settings
1947
2391
    server_defaults = { "interface": "",
1949
2393
                        "port": "",
1950
2394
                        "debug": "False",
1951
2395
                        "priority":
1952
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2396
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2397
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1953
2398
                        "servicename": "Mandos",
1954
2399
                        "use_dbus": "True",
1955
2400
                        "use_ipv6": "True",
1956
2401
                        "debuglevel": "",
1957
 
                        }
 
2402
                        "restore": "True",
 
2403
                        "socket": "",
 
2404
                        "statedir": "/var/lib/mandos",
 
2405
                        "foreground": "False",
 
2406
                        "zeroconf": "True",
 
2407
                    }
1958
2408
    
1959
2409
    # Parse config file for server-global settings
1960
2410
    server_config = configparser.SafeConfigParser(server_defaults)
1961
2411
    del server_defaults
1962
 
    server_config.read(os.path.join(options.configdir,
1963
 
                                    "mandos.conf"))
 
2412
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
1964
2413
    # Convert the SafeConfigParser object to a dict
1965
2414
    server_settings = server_config.defaults()
1966
2415
    # Use the appropriate methods on the non-string config options
1967
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2416
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1968
2417
        server_settings[option] = server_config.getboolean("DEFAULT",
1969
2418
                                                           option)
1970
2419
    if server_settings["port"]:
1971
2420
        server_settings["port"] = server_config.getint("DEFAULT",
1972
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"])
1973
2431
    del server_config
1974
2432
    
1975
2433
    # Override the settings from the config file with command line
1976
2434
    # options, if set.
1977
2435
    for option in ("interface", "address", "port", "debug",
1978
 
                   "priority", "servicename", "configdir",
1979
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore"):
 
2436
                   "priority", "servicename", "configdir", "use_dbus",
 
2437
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2438
                   "socket", "foreground", "zeroconf"):
1980
2439
        value = getattr(options, option)
1981
2440
        if value is not None:
1982
2441
            server_settings[option] = value
1983
2442
    del options
1984
2443
    # Force all strings to be unicode
1985
2444
    for option in server_settings.keys():
1986
 
        if type(server_settings[option]) is str:
1987
 
            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
1988
2455
    # Now we have our good server settings in "server_settings"
1989
2456
    
1990
2457
    ##################################################################
1991
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
    
1992
2464
    # For convenience
1993
2465
    debug = server_settings["debug"]
1994
2466
    debuglevel = server_settings["debuglevel"]
1995
2467
    use_dbus = server_settings["use_dbus"]
1996
2468
    use_ipv6 = server_settings["use_ipv6"]
 
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)
1997
2482
    
1998
2483
    if server_settings["servicename"] != "Mandos":
1999
 
        syslogger.setFormatter(logging.Formatter
2000
 
                               ('Mandos (%s) [%%(process)d]:'
2001
 
                                ' %%(levelname)s: %%(message)s'
2002
 
                                % server_settings["servicename"]))
 
2484
        syslogger.setFormatter(
 
2485
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2486
                              ' %(levelname)s: %(message)s'.format(
 
2487
                                  server_settings["servicename"])))
2003
2488
    
2004
2489
    # Parse config file with clients
2005
 
    client_defaults = { "timeout": "5m",
2006
 
                        "extended_timeout": "15m",
2007
 
                        "interval": "2m",
2008
 
                        "checker": "fping -q -- %%(host)s",
2009
 
                        "host": "",
2010
 
                        "approval_delay": "0s",
2011
 
                        "approval_duration": "1s",
2012
 
                        }
2013
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2490
    client_config = configparser.SafeConfigParser(Client
 
2491
                                                  .client_defaults)
2014
2492
    client_config.read(os.path.join(server_settings["configdir"],
2015
2493
                                    "clients.conf"))
2016
2494
    
2017
2495
    global mandos_dbus_service
2018
2496
    mandos_dbus_service = None
2019
2497
    
2020
 
    tcp_server = MandosServer((server_settings["address"],
2021
 
                               server_settings["port"]),
2022
 
                              ClientHandler,
2023
 
                              interface=(server_settings["interface"]
2024
 
                                         or None),
2025
 
                              use_ipv6=use_ipv6,
2026
 
                              gnutls_priority=
2027
 
                              server_settings["priority"],
2028
 
                              use_dbus=use_dbus)
2029
 
    if not debug:
2030
 
        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
2031
2514
        try:
2032
 
            pidfile = open(pidfilename, "w")
2033
 
        except IOError:
2034
 
            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)
2035
2519
    
2036
 
    try:
2037
 
        uid = pwd.getpwnam("_mandos").pw_uid
2038
 
        gid = pwd.getpwnam("_mandos").pw_gid
2039
 
    except KeyError:
 
2520
    for name in ("_mandos", "mandos", "nobody"):
2040
2521
        try:
2041
 
            uid = pwd.getpwnam("mandos").pw_uid
2042
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2522
            uid = pwd.getpwnam(name).pw_uid
 
2523
            gid = pwd.getpwnam(name).pw_gid
 
2524
            break
2043
2525
        except KeyError:
2044
 
            try:
2045
 
                uid = pwd.getpwnam("nobody").pw_uid
2046
 
                gid = pwd.getpwnam("nobody").pw_gid
2047
 
            except KeyError:
2048
 
                uid = 65534
2049
 
                gid = 65534
 
2526
            continue
 
2527
    else:
 
2528
        uid = 65534
 
2529
        gid = 65534
2050
2530
    try:
2051
2531
        os.setgid(gid)
2052
2532
        os.setuid(uid)
2053
2533
    except OSError as error:
2054
 
        if error[0] != errno.EPERM:
2055
 
            raise error
2056
 
    
2057
 
    if not debug and not debuglevel:
2058
 
        logger.setLevel(logging.WARNING)
2059
 
    if debuglevel:
2060
 
        level = getattr(logging, debuglevel.upper())
2061
 
        logger.setLevel(level)
 
2534
        if error.errno != errno.EPERM:
 
2535
            raise
2062
2536
    
2063
2537
    if debug:
2064
 
        logger.setLevel(logging.DEBUG)
2065
2538
        # Enable all possible GnuTLS debugging
2066
2539
        
2067
2540
        # "Use a log level over 10 to enable all debugging options."
2072
2545
        def debug_gnutls(level, string):
2073
2546
            logger.debug("GnuTLS: %s", string[:-1])
2074
2547
        
2075
 
        (gnutls.library.functions
2076
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2548
        gnutls.library.functions.gnutls_global_set_log_function(
 
2549
            debug_gnutls)
2077
2550
        
2078
2551
        # Redirect stdin so all checkers get /dev/null
2079
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2552
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2080
2553
        os.dup2(null, sys.stdin.fileno())
2081
2554
        if null > 2:
2082
2555
            os.close(null)
2083
 
    else:
2084
 
        # No console logging
2085
 
        logger.removeHandler(console)
2086
2556
    
2087
2557
    # Need to fork before connecting to D-Bus
2088
 
    if not debug:
 
2558
    if not foreground:
2089
2559
        # Close all input and output, do double fork, etc.
2090
2560
        daemon()
2091
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
    
2092
2566
    global main_loop
2093
2567
    # From the Avahi example code
2094
 
    DBusGMainLoop(set_as_default=True )
 
2568
    DBusGMainLoop(set_as_default=True)
2095
2569
    main_loop = gobject.MainLoop()
2096
2570
    bus = dbus.SystemBus()
2097
2571
    # End of Avahi example code
2098
2572
    if use_dbus:
2099
2573
        try:
2100
2574
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2101
 
                                            bus, do_not_queue=True)
2102
 
            old_bus_name = (dbus.service.BusName
2103
 
                            ("se.bsnet.fukt.Mandos", bus,
2104
 
                             do_not_queue=True))
2105
 
        except dbus.exceptions.NameExistsException as e:
2106
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
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)
2107
2582
            use_dbus = False
2108
2583
            server_settings["use_dbus"] = False
2109
2584
            tcp_server.use_dbus = False
2110
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2111
 
    service = AvahiServiceToSyslog(name =
2112
 
                                   server_settings["servicename"],
2113
 
                                   servicetype = "_mandos._tcp",
2114
 
                                   protocol = protocol, bus = bus)
2115
 
    if server_settings["interface"]:
2116
 
        service.interface = (if_nametoindex
2117
 
                             (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"))
2118
2595
    
2119
2596
    global multiprocessing_manager
2120
2597
    multiprocessing_manager = multiprocessing.Manager()
2121
2598
    
2122
2599
    client_class = Client
2123
2600
    if use_dbus:
2124
 
        client_class = functools.partial(ClientDBusTransitional,
2125
 
                                         bus = bus)
2126
 
    
2127
 
    special_settings = {
2128
 
        # Some settings need to be accessd by special methods;
2129
 
        # booleans need .getboolean(), etc.  Here is a list of them:
2130
 
        "approved_by_default":
2131
 
            lambda section:
2132
 
            client_config.getboolean(section, "approved_by_default"),
2133
 
        }
2134
 
    # Construct a new dict of client settings of this form:
2135
 
    # { client_name: {setting_name: value, ...}, ...}
2136
 
    # with exceptions for any special settings as defined above
2137
 
    client_settings = dict((clientname,
2138
 
                           dict((setting,
2139
 
                                 (value if
2140
 
                                  setting not in special_settings
2141
 
                                  else special_settings[setting]
2142
 
                                  (clientname)))
2143
 
                                for setting, value
2144
 
                                in client_config.items(clientname)))
2145
 
                          for clientname in client_config.sections())
2146
 
    
 
2601
        client_class = functools.partial(ClientDBus, bus = bus)
 
2602
    
 
2603
    client_settings = Client.config_parser(client_config)
2147
2604
    old_client_settings = {}
2148
 
    clients_data = []
2149
 
 
2150
 
    # Get client data and settings from last running state. 
 
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.
2151
2616
    if server_settings["restore"]:
2152
2617
        try:
2153
2618
            with open(stored_state_path, "rb") as stored_state:
2154
 
                clients_data, old_client_settings = (
2155
 
                    pickle.load(stored_state))
 
2619
                clients_data, old_client_settings = pickle.load(
 
2620
                    stored_state)
2156
2621
            os.remove(stored_state_path)
2157
2622
        except IOError as e:
2158
 
            logger.warning("Could not load persistant state: {0}"
2159
 
                           .format(e))
2160
 
            if e.errno != errno.ENOENT:
 
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)
2161
2629
                raise
2162
 
 
2163
 
    for client in clients_data:
2164
 
        client_name = client["name"]
2165
 
        
2166
 
        # Decide which value to use after restoring saved state.
2167
 
        # We have three different values: Old config file,
2168
 
        # new config file, and saved state.
2169
 
        # New config value takes precedence if it differs from old
2170
 
        # config value, otherwise use saved state.
2171
 
        for name, value in client_settings[client_name].items():
 
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))
2172
2686
            try:
2173
 
                # For each value in new config, check if it differs
2174
 
                # from the old config value (Except for the "secret"
2175
 
                # attribute)
2176
 
                if (name != "secret" and
2177
 
                    value != old_client_settings[client_name][name]):
2178
 
                    setattr(client, name, value)
2179
 
            except KeyError:
2180
 
                pass
2181
 
 
2182
 
        # Clients who has passed its expire date, can still be enabled
2183
 
        # if its last checker was sucessful. Clients who checkers
2184
 
        # failed before we stored it state is asumed to had failed
2185
 
        # checker during downtime.
2186
 
        if client["enabled"] and client["last_checked_ok"]:
2187
 
            if ((datetime.datetime.utcnow()
2188
 
                 - client["last_checked_ok"]) > client["interval"]):
2189
 
                if client["last_checker_status"] != 0:
2190
 
                    client["enabled"] = False
2191
 
                else:
2192
 
                    client["expires"] = (datetime.datetime.utcnow()
2193
 
                                         + client["timeout"])
2194
 
 
2195
 
        client["changedstate"] = (multiprocessing_manager
2196
 
                                  .Condition(multiprocessing_manager
2197
 
                                             .Lock()))
2198
 
        if use_dbus:
2199
 
            new_client = ClientDBusTransitional.__new__(
2200
 
                ClientDBusTransitional)
2201
 
            tcp_server.clients[client_name] = new_client
2202
 
            new_client.bus = bus
2203
 
            for name, value in client.iteritems():
2204
 
                setattr(new_client, name, value)
2205
 
            new_client._approvals_pending = 0
2206
 
            new_client.add_to_dbus()
2207
 
        else:
2208
 
            tcp_server.clients[client_name] = Client.__new__(Client)
2209
 
            for name, value in client.iteritems():
2210
 
                setattr(tcp_server.clients[client_name], name, value)
2211
 
                
2212
 
        tcp_server.clients[client_name].decrypt_secret(
2213
 
            client_settings[client_name]["secret"])            
2214
 
        
2215
 
    # Create/remove clients based on new changes made to config
2216
 
    for clientname in set(old_client_settings) - set(client_settings):
2217
 
        del tcp_server.clients[clientname]
2218
 
    for clientname in set(client_settings) - set(old_client_settings):
2219
 
        tcp_server.clients[clientname] = client_class(name
2220
 
                                                      = clientname,
2221
 
                                                      config =
2222
 
                                                      client_settings
2223
 
                                                      [clientname])
 
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)
2224
2711
    
2225
2712
    if not tcp_server.clients:
2226
2713
        logger.warning("No clients defined")
2227
 
        
2228
 
    if not debug:
2229
 
        try:
2230
 
            with pidfile:
2231
 
                pid = os.getpid()
2232
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2233
 
            del pidfile
2234
 
        except IOError:
2235
 
            logger.error("Could not write to file %r with PID %d",
2236
 
                         pidfilename, pid)
2237
 
        except NameError:
2238
 
            # "pidfile" was never created
2239
 
            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
2240
2725
        del pidfilename
2241
 
        
2242
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2243
2726
    
2244
2727
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2245
2728
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2246
2729
    
2247
2730
    if use_dbus:
2248
 
        class MandosDBusService(dbus.service.Object):
 
2731
        
 
2732
        @alternate_dbus_interfaces(
 
2733
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2734
        class MandosDBusService(DBusObjectWithProperties):
2249
2735
            """A D-Bus proxy object"""
 
2736
            
2250
2737
            def __init__(self):
2251
2738
                dbus.service.Object.__init__(self, bus, "/")
 
2739
            
2252
2740
            _interface = "se.recompile.Mandos"
2253
2741
            
 
2742
            @dbus_interface_annotations(_interface)
 
2743
            def _foo(self):
 
2744
                return {
 
2745
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2746
                    "false" }
 
2747
            
2254
2748
            @dbus.service.signal(_interface, signature="o")
2255
2749
            def ClientAdded(self, objpath):
2256
2750
                "D-Bus signal"
2269
2763
            @dbus.service.method(_interface, out_signature="ao")
2270
2764
            def GetAllClients(self):
2271
2765
                "D-Bus method"
2272
 
                return dbus.Array(c.dbus_object_path
2273
 
                                  for c in
 
2766
                return dbus.Array(c.dbus_object_path for c in
2274
2767
                                  tcp_server.clients.itervalues())
2275
2768
            
2276
2769
            @dbus.service.method(_interface,
2278
2771
            def GetAllClientsWithProperties(self):
2279
2772
                "D-Bus method"
2280
2773
                return dbus.Dictionary(
2281
 
                    ((c.dbus_object_path, c.GetAll(""))
2282
 
                     for c in tcp_server.clients.itervalues()),
 
2774
                    { c.dbus_object_path: c.GetAll("")
 
2775
                      for c in tcp_server.clients.itervalues() },
2283
2776
                    signature="oa{sv}")
2284
2777
            
2285
2778
            @dbus.service.method(_interface, in_signature="o")
2298
2791
            
2299
2792
            del _interface
2300
2793
        
2301
 
        class MandosDBusServiceTransitional(MandosDBusService):
2302
 
            __metaclass__ = AlternateDBusNamesMetaclass
2303
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2794
        mandos_dbus_service = MandosDBusService()
2304
2795
    
2305
2796
    def cleanup():
2306
2797
        "Cleanup function; run on exit"
2307
 
        service.cleanup()
 
2798
        if zeroconf:
 
2799
            service.cleanup()
2308
2800
        
2309
2801
        multiprocessing.active_children()
 
2802
        wnull.close()
2310
2803
        if not (tcp_server.clients or client_settings):
2311
2804
            return
2312
 
 
 
2805
        
2313
2806
        # Store client before exiting. Secrets are encrypted with key
2314
2807
        # based on what config file has. If config file is
2315
2808
        # removed/edited, old secret will thus be unrecovable.
2316
 
        clients = []
2317
 
        for client in tcp_server.clients.itervalues():
2318
 
            client.encrypt_secret(
2319
 
                client_settings[client.name]["secret"])
2320
 
 
2321
 
            client_dict = {}
2322
 
 
2323
 
            # A list of attributes that will not be stored when
2324
 
            # shutting down.
2325
 
            exclude = set(("bus", "changedstate", "secret"))
2326
 
            for name, typ in inspect.getmembers(dbus.service.Object):
2327
 
                exclude.add(name)
2328
 
                
2329
 
            client_dict["encrypted_secret"] = client.encrypted_secret
2330
 
            for attr in client.client_structure:
2331
 
                if attr not in exclude:
2332
 
                    client_dict[attr] = getattr(client, attr)
2333
 
 
2334
 
            clients.append(client_dict) 
2335
 
            del client_settings[client.name]["secret"]
2336
 
            
 
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
        
2337
2834
        try:
2338
 
            with os.fdopen(os.open(stored_state_path,
2339
 
                                   os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2340
 
                                   stat.S_IRUSR | stat.S_IWUSR),
2341
 
                           "wb") as stored_state:
 
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:
2342
2841
                pickle.dump((clients, client_settings), stored_state)
2343
 
        except IOError as e:
2344
 
            logger.warning("Could not save persistant state: {0}"
2345
 
                           .format(e))
2346
 
            if e.errno != errno.ENOENT:
 
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)
2347
2856
                raise
2348
 
 
 
2857
        
2349
2858
        # Delete all clients, and settings from config
2350
2859
        while tcp_server.clients:
2351
2860
            name, client = tcp_server.clients.popitem()
2355
2864
            client.disable(quiet=True)
2356
2865
            if use_dbus:
2357
2866
                # Emit D-Bus signal
2358
 
                mandos_dbus_service.ClientRemoved(client
2359
 
                                                  .dbus_object_path,
2360
 
                                                  client.name)
 
2867
                mandos_dbus_service.ClientRemoved(
 
2868
                    client.dbus_object_path, client.name)
2361
2869
        client_settings.clear()
2362
2870
    
2363
2871
    atexit.register(cleanup)
2369
2877
        # Need to initiate checking of clients
2370
2878
        if client.enabled:
2371
2879
            client.init_checker()
2372
 
 
2373
2880
    
2374
2881
    tcp_server.enable()
2375
2882
    tcp_server.server_activate()
2376
2883
    
2377
2884
    # Find out what port we got
2378
 
    service.port = tcp_server.socket.getsockname()[1]
 
2885
    if zeroconf:
 
2886
        service.port = tcp_server.socket.getsockname()[1]
2379
2887
    if use_ipv6:
2380
2888
        logger.info("Now listening on address %r, port %d,"
2381
 
                    " flowinfo %d, scope_id %d"
2382
 
                    % tcp_server.socket.getsockname())
 
2889
                    " flowinfo %d, scope_id %d",
 
2890
                    *tcp_server.socket.getsockname())
2383
2891
    else:                       # IPv4
2384
 
        logger.info("Now listening on address %r, port %d"
2385
 
                    % tcp_server.socket.getsockname())
 
2892
        logger.info("Now listening on address %r, port %d",
 
2893
                    *tcp_server.socket.getsockname())
2386
2894
    
2387
2895
    #service.interface = tcp_server.socket.getsockname()[3]
2388
2896
    
2389
2897
    try:
2390
 
        # From the Avahi example code
2391
 
        try:
2392
 
            service.activate()
2393
 
        except dbus.exceptions.DBusException as error:
2394
 
            logger.critical("DBusException: %s", error)
2395
 
            cleanup()
2396
 
            sys.exit(1)
2397
 
        # 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
2398
2907
        
2399
2908
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2400
2909
                             lambda *args, **kwargs:
2404
2913
        logger.debug("Starting main loop")
2405
2914
        main_loop.run()
2406
2915
    except AvahiError as error:
2407
 
        logger.critical("AvahiError: %s", error)
 
2916
        logger.critical("Avahi Error", exc_info=error)
2408
2917
        cleanup()
2409
2918
        sys.exit(1)
2410
2919
    except KeyboardInterrupt: