/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-08-02 09:36:40 UTC
  • Revision ID: teddy@recompile.se-20150802093640-nc0n17rbmqlbaxuf
Add D-Bus annotations on a few properties on the Client object.

The D-Bus property "Secret" on the interface
"se.recompile.Mandos.Client" should have the annotation
"org.freedesktop.DBus.Property.EmitsChangedSignal" set to
"invalidates".  Also, the properties "Created", "Fingerprint", "Name",
and "ObjectPath" should have the same annotation set to "const".

* mandos (ClientDBus.Name_dbus_property): Set annotation
                    "org.freedesktop.DBus.Property.EmitsChangedSignal"
                    to "const".
  (ClientDBus.Fingerprint_dbus_property): - '' -
  (ClientDBus.Created_dbus_property): - '' -
  (ClientDBus.ObjectPath_dbus_property): - '' -
  (ClientDBus.Secret_dbus_property): Set annotation
                    "org.freedesktop.DBus.Property.EmitsChangedSignal"
                    to "invalidates".

Show diffs side-by-side

added added

removed removed

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