/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-08-10 16:19:28 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150810161928-bnukog7l47j3pjix
Depend on Avahi and the network in the server's systemd service file.

* mandos.service ([Unit]/After): New; set to "network.target" and
  "avahi-daemon.service".
  ([Unit]/RequisiteOverridable): New; set to "avahi-daemon.service".

Show diffs side-by-side

added added

removed removed

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