/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
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
31
# Contact the authors at <mandos@recompile.se>.
32
32
33
33
 
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
import SocketServer as socketserver
 
37
from future_builtins import *
 
38
 
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
38
43
import socket
39
44
import argparse
40
45
import datetime
45
50
import gnutls.library.functions
46
51
import gnutls.library.constants
47
52
import gnutls.library.types
48
 
import ConfigParser as configparser
 
53
try:
 
54
    import ConfigParser as configparser
 
55
except ImportError:
 
56
    import configparser
49
57
import sys
50
58
import re
51
59
import os
60
68
import struct
61
69
import fcntl
62
70
import functools
63
 
import cPickle as pickle
 
71
try:
 
72
    import cPickle as pickle
 
73
except ImportError:
 
74
    import pickle
64
75
import multiprocessing
 
76
import types
 
77
import binascii
 
78
import tempfile
 
79
import itertools
 
80
import collections
 
81
import codecs
65
82
 
66
83
import dbus
67
84
import dbus.service
68
 
import gobject
 
85
try:
 
86
    import gobject
 
87
except ImportError:
 
88
    from gi.repository import GObject as gobject
69
89
import avahi
70
90
from dbus.mainloop.glib import DBusGMainLoop
71
91
import ctypes
81
101
    except ImportError:
82
102
        SO_BINDTODEVICE = None
83
103
 
84
 
 
85
 
version = "1.3.1"
86
 
 
87
 
#logger = logging.getLogger('mandos')
88
 
logger = logging.Logger('mandos')
89
 
syslogger = (logging.handlers.SysLogHandler
90
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
 
              address = str("/dev/log")))
92
 
syslogger.setFormatter(logging.Formatter
93
 
                       ('Mandos [%(process)d]: %(levelname)s:'
94
 
                        ' %(message)s'))
95
 
logger.addHandler(syslogger)
96
 
 
97
 
console = logging.StreamHandler()
98
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
99
 
                                       ' %(levelname)s:'
100
 
                                       ' %(message)s'))
101
 
logger.addHandler(console)
 
104
if sys.version_info.major == 2:
 
105
    str = unicode
 
106
 
 
107
version = "1.6.9"
 
108
stored_state_file = "clients.pickle"
 
109
 
 
110
logger = logging.getLogger()
 
111
syslogger = None
 
112
 
 
113
try:
 
114
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
115
        ctypes.util.find_library("c")).if_nametoindex
 
116
except (OSError, AttributeError):
 
117
    
 
118
    def if_nametoindex(interface):
 
119
        "Get an interface index the hard way, i.e. using fcntl()"
 
120
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
121
        with contextlib.closing(socket.socket()) as s:
 
122
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
123
                                struct.pack(b"16s16x", interface))
 
124
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
125
        return interface_index
 
126
 
 
127
 
 
128
def initlogger(debug, level=logging.WARNING):
 
129
    """init logger and add loglevel"""
 
130
    
 
131
    global syslogger
 
132
    syslogger = (logging.handlers.SysLogHandler(
 
133
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
134
        address = "/dev/log"))
 
135
    syslogger.setFormatter(logging.Formatter
 
136
                           ('Mandos [%(process)d]: %(levelname)s:'
 
137
                            ' %(message)s'))
 
138
    logger.addHandler(syslogger)
 
139
    
 
140
    if debug:
 
141
        console = logging.StreamHandler()
 
142
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
143
                                               ' [%(process)d]:'
 
144
                                               ' %(levelname)s:'
 
145
                                               ' %(message)s'))
 
146
        logger.addHandler(console)
 
147
    logger.setLevel(level)
 
148
 
 
149
 
 
150
class PGPError(Exception):
 
151
    """Exception if encryption/decryption fails"""
 
152
    pass
 
153
 
 
154
 
 
155
class PGPEngine(object):
 
156
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
157
    
 
158
    def __init__(self):
 
159
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
160
        self.gnupgargs = ['--batch',
 
161
                          '--home', self.tempdir,
 
162
                          '--force-mdc',
 
163
                          '--quiet',
 
164
                          '--no-use-agent']
 
165
    
 
166
    def __enter__(self):
 
167
        return self
 
168
    
 
169
    def __exit__(self, exc_type, exc_value, traceback):
 
170
        self._cleanup()
 
171
        return False
 
172
    
 
173
    def __del__(self):
 
174
        self._cleanup()
 
175
    
 
176
    def _cleanup(self):
 
177
        if self.tempdir is not None:
 
178
            # Delete contents of tempdir
 
179
            for root, dirs, files in os.walk(self.tempdir,
 
180
                                             topdown = False):
 
181
                for filename in files:
 
182
                    os.remove(os.path.join(root, filename))
 
183
                for dirname in dirs:
 
184
                    os.rmdir(os.path.join(root, dirname))
 
185
            # Remove tempdir
 
186
            os.rmdir(self.tempdir)
 
187
            self.tempdir = None
 
188
    
 
189
    def password_encode(self, password):
 
190
        # Passphrase can not be empty and can not contain newlines or
 
191
        # NUL bytes.  So we prefix it and hex encode it.
 
192
        encoded = b"mandos" + binascii.hexlify(password)
 
193
        if len(encoded) > 2048:
 
194
            # GnuPG can't handle long passwords, so encode differently
 
195
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
196
                       .replace(b"\n", b"\\n")
 
197
                       .replace(b"\0", b"\\x00"))
 
198
        return encoded
 
199
    
 
200
    def encrypt(self, data, password):
 
201
        passphrase = self.password_encode(password)
 
202
        with tempfile.NamedTemporaryFile(
 
203
                dir=self.tempdir) as passfile:
 
204
            passfile.write(passphrase)
 
205
            passfile.flush()
 
206
            proc = subprocess.Popen(['gpg', '--symmetric',
 
207
                                     '--passphrase-file',
 
208
                                     passfile.name]
 
209
                                    + self.gnupgargs,
 
210
                                    stdin = subprocess.PIPE,
 
211
                                    stdout = subprocess.PIPE,
 
212
                                    stderr = subprocess.PIPE)
 
213
            ciphertext, err = proc.communicate(input = data)
 
214
        if proc.returncode != 0:
 
215
            raise PGPError(err)
 
216
        return ciphertext
 
217
    
 
218
    def decrypt(self, data, password):
 
219
        passphrase = self.password_encode(password)
 
220
        with tempfile.NamedTemporaryFile(
 
221
                dir = self.tempdir) as passfile:
 
222
            passfile.write(passphrase)
 
223
            passfile.flush()
 
224
            proc = subprocess.Popen(['gpg', '--decrypt',
 
225
                                     '--passphrase-file',
 
226
                                     passfile.name]
 
227
                                    + self.gnupgargs,
 
228
                                    stdin = subprocess.PIPE,
 
229
                                    stdout = subprocess.PIPE,
 
230
                                    stderr = subprocess.PIPE)
 
231
            decrypted_plaintext, err = proc.communicate(input = data)
 
232
        if proc.returncode != 0:
 
233
            raise PGPError(err)
 
234
        return decrypted_plaintext
 
235
 
102
236
 
103
237
class AvahiError(Exception):
104
238
    def __init__(self, value, *args, **kwargs):
105
239
        self.value = value
106
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
107
 
    def __unicode__(self):
108
 
        return unicode(repr(self.value))
 
240
        return super(AvahiError, self).__init__(value, *args,
 
241
                                                **kwargs)
 
242
 
109
243
 
110
244
class AvahiServiceError(AvahiError):
111
245
    pass
112
246
 
 
247
 
113
248
class AvahiGroupError(AvahiError):
114
249
    pass
115
250
 
122
257
               Used to optionally bind to the specified interface.
123
258
    name: string; Example: 'Mandos'
124
259
    type: string; Example: '_mandos._tcp'.
125
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
260
     See <https://www.iana.org/assignments/service-names-port-numbers>
126
261
    port: integer; what port to announce
127
262
    TXT: list of strings; TXT record for the service
128
263
    domain: string; Domain to publish on, default to .local if empty.
134
269
    server: D-Bus Server
135
270
    bus: dbus.SystemBus()
136
271
    """
137
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
138
 
                 servicetype = None, port = None, TXT = None,
139
 
                 domain = "", host = "", max_renames = 32768,
140
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
272
    
 
273
    def __init__(self,
 
274
                 interface = avahi.IF_UNSPEC,
 
275
                 name = None,
 
276
                 servicetype = None,
 
277
                 port = None,
 
278
                 TXT = None,
 
279
                 domain = "",
 
280
                 host = "",
 
281
                 max_renames = 32768,
 
282
                 protocol = avahi.PROTO_UNSPEC,
 
283
                 bus = None):
141
284
        self.interface = interface
142
285
        self.name = name
143
286
        self.type = servicetype
152
295
        self.server = None
153
296
        self.bus = bus
154
297
        self.entry_group_state_changed_match = None
155
 
    def rename(self):
 
298
    
 
299
    def rename(self, remove=True):
156
300
        """Derived from the Avahi example code"""
157
301
        if self.rename_count >= self.max_renames:
158
302
            logger.critical("No suitable Zeroconf service name found"
159
303
                            " after %i retries, exiting.",
160
304
                            self.rename_count)
161
305
            raise AvahiServiceError("Too many renames")
162
 
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
 
306
        self.name = str(
 
307
            self.server.GetAlternativeServiceName(self.name))
 
308
        self.rename_count += 1
163
309
        logger.info("Changing Zeroconf service name to %r ...",
164
310
                    self.name)
165
 
        syslogger.setFormatter(logging.Formatter
166
 
                               ('Mandos (%s) [%%(process)d]:'
167
 
                                ' %%(levelname)s: %%(message)s'
168
 
                                % self.name))
169
 
        self.remove()
 
311
        if remove:
 
312
            self.remove()
170
313
        try:
171
314
            self.add()
172
315
        except dbus.exceptions.DBusException as error:
173
 
            logger.critical("DBusException: %s", error)
174
 
            self.cleanup()
175
 
            os._exit(1)
176
 
        self.rename_count += 1
 
316
            if (error.get_dbus_name()
 
317
                == "org.freedesktop.Avahi.CollisionError"):
 
318
                logger.info("Local Zeroconf service name collision.")
 
319
                return self.rename(remove=False)
 
320
            else:
 
321
                logger.critical("D-Bus Exception", exc_info=error)
 
322
                self.cleanup()
 
323
                os._exit(1)
 
324
    
177
325
    def remove(self):
178
326
        """Derived from the Avahi example code"""
179
327
        if self.entry_group_state_changed_match is not None:
181
329
            self.entry_group_state_changed_match = None
182
330
        if self.group is not None:
183
331
            self.group.Reset()
 
332
    
184
333
    def add(self):
185
334
        """Derived from the Avahi example code"""
186
335
        self.remove()
191
340
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
192
341
        self.entry_group_state_changed_match = (
193
342
            self.group.connect_to_signal(
194
 
                'StateChanged', self .entry_group_state_changed))
 
343
                'StateChanged', self.entry_group_state_changed))
195
344
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
196
345
                     self.name, self.type)
197
346
        self.group.AddService(
203
352
            dbus.UInt16(self.port),
204
353
            avahi.string_array_to_txt_array(self.TXT))
205
354
        self.group.Commit()
 
355
    
206
356
    def entry_group_state_changed(self, state, error):
207
357
        """Derived from the Avahi example code"""
208
358
        logger.debug("Avahi entry group state change: %i", state)
214
364
            self.rename()
215
365
        elif state == avahi.ENTRY_GROUP_FAILURE:
216
366
            logger.critical("Avahi: Error in group state changed %s",
217
 
                            unicode(error))
218
 
            raise AvahiGroupError("State changed: %s"
219
 
                                  % unicode(error))
 
367
                            str(error))
 
368
            raise AvahiGroupError("State changed: {!s}".format(error))
 
369
    
220
370
    def cleanup(self):
221
371
        """Derived from the Avahi example code"""
222
372
        if self.group is not None:
223
373
            try:
224
374
                self.group.Free()
225
375
            except (dbus.exceptions.UnknownMethodException,
226
 
                    dbus.exceptions.DBusException) as e:
 
376
                    dbus.exceptions.DBusException):
227
377
                pass
228
378
            self.group = None
229
379
        self.remove()
 
380
    
230
381
    def server_state_changed(self, state, error=None):
231
382
        """Derived from the Avahi example code"""
232
383
        logger.debug("Avahi server state change: %i", state)
233
 
        bad_states = { avahi.SERVER_INVALID:
234
 
                           "Zeroconf server invalid",
235
 
                       avahi.SERVER_REGISTERING: None,
236
 
                       avahi.SERVER_COLLISION:
237
 
                           "Zeroconf server name collision",
238
 
                       avahi.SERVER_FAILURE:
239
 
                           "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
        }
240
390
        if state in bad_states:
241
391
            if bad_states[state] is not None:
242
392
                if error is None:
245
395
                    logger.error(bad_states[state] + ": %r", error)
246
396
            self.cleanup()
247
397
        elif state == avahi.SERVER_RUNNING:
248
 
            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)
249
410
        else:
250
411
            if error is None:
251
412
                logger.debug("Unknown state: %r", state)
252
413
            else:
253
414
                logger.debug("Unknown state: %r: %r", state, error)
 
415
    
254
416
    def activate(self):
255
417
        """Derived from the Avahi example code"""
256
418
        if self.server is None:
260
422
                                    follow_name_owner_changes=True),
261
423
                avahi.DBUS_INTERFACE_SERVER)
262
424
        self.server.connect_to_signal("StateChanged",
263
 
                                 self.server_state_changed)
 
425
                                      self.server_state_changed)
264
426
        self.server_state_changed(self.server.GetState())
265
427
 
266
428
 
267
 
def _timedelta_to_milliseconds(td):
268
 
    "Convert a datetime.timedelta() to milliseconds"
269
 
    return ((td.days * 24 * 60 * 60 * 1000)
270
 
            + (td.seconds * 1000)
271
 
            + (td.microseconds // 1000))
272
 
        
 
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
 
273
448
class Client(object):
274
449
    """A representation of a client host served by this server.
275
450
    
276
451
    Attributes:
277
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
452
    approved:   bool(); 'None' if not yet approved/disapproved
278
453
    approval_delay: datetime.timedelta(); Time to wait for approval
279
454
    approval_duration: datetime.timedelta(); Duration of one approval
280
455
    checker:    subprocess.Popen(); a running checker process used
287
462
                     instance %(name)s can be used in the command.
288
463
    checker_initiator_tag: a gobject event source tag, or None
289
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
290
467
    current_checker_command: string; current running checker_command
291
 
    disable_hook:  If set, called by disable() as disable_hook(self)
292
468
    disable_initiator_tag: a gobject event source tag, or None
293
469
    enabled:    bool()
294
470
    fingerprint: string (40 or 32 hexadecimal digits); used to
297
473
    interval:   datetime.timedelta(); How often to start a new checker
298
474
    last_approval_request: datetime.datetime(); (UTC) or None
299
475
    last_checked_ok: datetime.datetime(); (UTC) or None
300
 
    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
301
482
    name:       string; from the config file, used in log messages and
302
483
                        D-Bus identifiers
303
484
    secret:     bytestring; sent verbatim (over TLS) to client
304
485
    timeout:    datetime.timedelta(); How long from last_checked_ok
305
486
                                      until this client is disabled
306
 
    extended_timeout:   extra long timeout when password has been sent
 
487
    extended_timeout:   extra long timeout when secret has been sent
307
488
    runtime_expansions: Allowed attributes for runtime expansion.
308
489
    expires:    datetime.datetime(); time (UTC) when a client will be
309
490
                disabled, or None
 
491
    server_settings: The server_settings dict from main()
310
492
    """
311
493
    
312
494
    runtime_expansions = ("approval_delay", "approval_duration",
313
 
                          "created", "enabled", "fingerprint",
314
 
                          "host", "interval", "last_checked_ok",
 
495
                          "created", "enabled", "expires",
 
496
                          "fingerprint", "host", "interval",
 
497
                          "last_approval_request", "last_checked_ok",
315
498
                          "last_enabled", "name", "timeout")
 
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
316
558
        
317
 
    def timeout_milliseconds(self):
318
 
        "Return the 'timeout' attribute in milliseconds"
319
 
        return _timedelta_to_milliseconds(self.timeout)
320
 
 
321
 
    def extended_timeout_milliseconds(self):
322
 
        "Return the 'extended_timeout' attribute in milliseconds"
323
 
        return _timedelta_to_milliseconds(self.extended_timeout)    
324
 
    
325
 
    def interval_milliseconds(self):
326
 
        "Return the 'interval' attribute in milliseconds"
327
 
        return _timedelta_to_milliseconds(self.interval)
328
 
 
329
 
    def approval_delay_milliseconds(self):
330
 
        return _timedelta_to_milliseconds(self.approval_delay)
331
 
    
332
 
    def __init__(self, name = None, disable_hook=None, config=None):
333
 
        """Note: the 'checker' key in 'config' sets the
334
 
        'checker_command' attribute and *not* the 'checker'
335
 
        attribute."""
 
559
        return settings
 
560
    
 
561
    def __init__(self, settings, name = None, server_settings=None):
336
562
        self.name = name
337
 
        if config is None:
338
 
            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
        
339
580
        logger.debug("Creating client %r", self.name)
340
 
        # Uppercase and remove spaces from fingerprint for later
341
 
        # comparison purposes with return value from the fingerprint()
342
 
        # function
343
 
        self.fingerprint = (config["fingerprint"].upper()
344
 
                            .replace(" ", ""))
345
581
        logger.debug("  Fingerprint: %s", self.fingerprint)
346
 
        if "secret" in config:
347
 
            self.secret = config["secret"].decode("base64")
348
 
        elif "secfile" in config:
349
 
            with open(os.path.expanduser(os.path.expandvars
350
 
                                         (config["secfile"])),
351
 
                      "rb") as secfile:
352
 
                self.secret = secfile.read()
353
 
        else:
354
 
            raise TypeError("No secret or secfile for client %s"
355
 
                            % self.name)
356
 
        self.host = config.get("host", "")
357
 
        self.created = datetime.datetime.utcnow()
358
 
        self.enabled = False
359
 
        self.last_approval_request = None
360
 
        self.last_enabled = None
361
 
        self.last_checked_ok = None
362
 
        self.timeout = string_to_delta(config["timeout"])
363
 
        self.extended_timeout = string_to_delta(config["extended_timeout"])
364
 
        self.interval = string_to_delta(config["interval"])
365
 
        self.disable_hook = disable_hook
 
582
        self.created = settings.get("created",
 
583
                                    datetime.datetime.utcnow())
 
584
        
 
585
        # attributes specific for this server instance
366
586
        self.checker = None
367
587
        self.checker_initiator_tag = None
368
588
        self.disable_initiator_tag = None
369
 
        self.expires = None
370
589
        self.checker_callback_tag = None
371
 
        self.checker_command = config["checker"]
372
590
        self.current_checker_command = None
373
 
        self.last_connect = None
374
 
        self._approved = None
375
 
        self.approved_by_default = config.get("approved_by_default",
376
 
                                              True)
 
591
        self.approved = None
377
592
        self.approvals_pending = 0
378
 
        self.approval_delay = string_to_delta(
379
 
            config["approval_delay"])
380
 
        self.approval_duration = string_to_delta(
381
 
            config["approval_duration"])
382
 
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
 
593
        self.changedstate = multiprocessing_manager.Condition(
 
594
            multiprocessing_manager.Lock())
 
595
        self.client_structure = [attr
 
596
                                 for attr in self.__dict__.iterkeys()
 
597
                                 if not attr.startswith("_")]
 
598
        self.client_structure.append("client_structure")
 
599
        
 
600
        for name, t in inspect.getmembers(
 
601
                type(self), lambda obj: isinstance(obj, property)):
 
602
            if not name.startswith("_"):
 
603
                self.client_structure.append(name)
383
604
    
 
605
    # Send notice to process children that client state has changed
384
606
    def send_changedstate(self):
385
 
        self.changedstate.acquire()
386
 
        self.changedstate.notify_all()
387
 
        self.changedstate.release()
388
 
        
 
607
        with self.changedstate:
 
608
            self.changedstate.notify_all()
 
609
    
389
610
    def enable(self):
390
611
        """Start this client's checker and timeout hooks"""
391
612
        if getattr(self, "enabled", False):
392
613
            # Already enabled
393
614
            return
394
 
        self.send_changedstate()
395
 
        # Schedule a new checker to be started an 'interval' from now,
396
 
        # and every interval from then on.
397
 
        self.checker_initiator_tag = (gobject.timeout_add
398
 
                                      (self.interval_milliseconds(),
399
 
                                       self.start_checker))
400
 
        # Schedule a disable() when 'timeout' has passed
401
615
        self.expires = datetime.datetime.utcnow() + self.timeout
402
 
        self.disable_initiator_tag = (gobject.timeout_add
403
 
                                   (self.timeout_milliseconds(),
404
 
                                    self.disable))
405
616
        self.enabled = True
406
617
        self.last_enabled = datetime.datetime.utcnow()
407
 
        # Also start a new checker *right now*.
408
 
        self.start_checker()
 
618
        self.init_checker()
 
619
        self.send_changedstate()
409
620
    
410
621
    def disable(self, quiet=True):
411
622
        """Disable this client."""
412
623
        if not getattr(self, "enabled", False):
413
624
            return False
414
625
        if not quiet:
415
 
            self.send_changedstate()
416
 
        if not quiet:
417
626
            logger.info("Disabling client %s", self.name)
418
 
        if getattr(self, "disable_initiator_tag", False):
 
627
        if getattr(self, "disable_initiator_tag", None) is not None:
419
628
            gobject.source_remove(self.disable_initiator_tag)
420
629
            self.disable_initiator_tag = None
421
630
        self.expires = None
422
 
        if getattr(self, "checker_initiator_tag", False):
 
631
        if getattr(self, "checker_initiator_tag", None) is not None:
423
632
            gobject.source_remove(self.checker_initiator_tag)
424
633
            self.checker_initiator_tag = None
425
634
        self.stop_checker()
426
 
        if self.disable_hook:
427
 
            self.disable_hook(self)
428
635
        self.enabled = False
 
636
        if not quiet:
 
637
            self.send_changedstate()
429
638
        # Do not run this again if called by a gobject.timeout_add
430
639
        return False
431
640
    
432
641
    def __del__(self):
433
 
        self.disable_hook = None
434
642
        self.disable()
435
643
    
436
 
    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):
437
662
        """The checker has completed, so take appropriate actions."""
438
663
        self.checker_callback_tag = None
439
664
        self.checker = None
440
 
        if os.WIFEXITED(condition):
441
 
            exitstatus = os.WEXITSTATUS(condition)
442
 
            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:
443
673
                logger.info("Checker for %(name)s succeeded",
444
674
                            vars(self))
445
675
                self.checked_ok()
446
676
            else:
447
 
                logger.info("Checker for %(name)s failed",
448
 
                            vars(self))
 
677
                logger.info("Checker for %(name)s failed", vars(self))
449
678
        else:
 
679
            self.last_checker_status = -1
 
680
            self.last_checker_signal = -returncode
450
681
            logger.warning("Checker for %(name)s crashed?",
451
682
                           vars(self))
452
 
    
453
 
    def checked_ok(self, timeout=None):
454
 
        """Bump up the timeout for this client.
455
 
        
456
 
        This should only be called when the client has been seen,
457
 
        alive and well.
458
 
        """
 
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."""
459
694
        if timeout is None:
460
695
            timeout = self.timeout
461
 
        self.last_checked_ok = datetime.datetime.utcnow()
462
 
        gobject.source_remove(self.disable_initiator_tag)
463
 
        self.expires = datetime.datetime.utcnow() + timeout
464
 
        self.disable_initiator_tag = (gobject.timeout_add
465
 
                                      (_timedelta_to_milliseconds(timeout),
466
 
                                       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
467
703
    
468
704
    def need_approval(self):
469
705
        self.last_approval_request = datetime.datetime.utcnow()
474
710
        If a checker already exists, leave it running and do
475
711
        nothing."""
476
712
        # The reason for not killing a running checker is that if we
477
 
        # did that, then if a checker (for some reason) started
478
 
        # running slowly and taking more than 'interval' time, the
479
 
        # client would inevitably timeout, since no checker would get
480
 
        # 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
481
717
        # checkers alone, the checker would have to take more time
482
718
        # than 'timeout' for the client to be disabled, which is as it
483
719
        # should be.
484
720
        
485
 
        # If a checker exists, make sure it is not a zombie
486
 
        try:
487
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
488
 
        except (AttributeError, OSError) as error:
489
 
            if (isinstance(error, OSError)
490
 
                and error.errno != errno.ECHILD):
491
 
                raise error
492
 
        else:
493
 
            if pid:
494
 
                logger.warning("Checker was a zombie")
495
 
                gobject.source_remove(self.checker_callback_tag)
496
 
                self.checker_callback(pid, status,
497
 
                                      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
498
725
        # Start a new checker if needed
499
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 }
500
731
            try:
501
 
                # In case checker_command has exactly one % operator
502
 
                command = self.checker_command % self.host
503
 
            except TypeError:
504
 
                # Escape attributes for the shell
505
 
                escaped_attrs = dict(
506
 
                    (attr,
507
 
                     re.escape(unicode(str(getattr(self, attr, "")),
508
 
                                       errors=
509
 
                                       'replace')))
510
 
                    for attr in
511
 
                    self.runtime_expansions)
512
 
 
513
 
                try:
514
 
                    command = self.checker_command % escaped_attrs
515
 
                except TypeError as error:
516
 
                    logger.error('Could not format string "%s":'
517
 
                                 ' %s', self.checker_command, error)
518
 
                    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
519
738
            self.current_checker_command = command
520
 
            try:
521
 
                logger.info("Starting checker %r for %s",
522
 
                            command, self.name)
523
 
                # We don't need to redirect stdout and stderr, since
524
 
                # in normal mode, that is already done by daemon(),
525
 
                # and in debug mode we don't want to.  (Stdin is
526
 
                # always replaced by /dev/null.)
527
 
                self.checker = subprocess.Popen(command,
528
 
                                                close_fds=True,
529
 
                                                shell=True, cwd="/")
530
 
                self.checker_callback_tag = (gobject.child_watch_add
531
 
                                             (self.checker.pid,
532
 
                                              self.checker_callback,
533
 
                                              data=command))
534
 
                # The checker may have completed before the gobject
535
 
                # watch was added.  Check for this.
536
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
537
 
                if pid:
538
 
                    gobject.source_remove(self.checker_callback_tag)
539
 
                    self.checker_callback(pid, status, command)
540
 
            except OSError as error:
541
 
                logger.error("Failed to start subprocess: %s",
542
 
                             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)
543
764
        # Re-run this periodically if run by gobject.timeout_add
544
765
        return True
545
766
    
551
772
        if getattr(self, "checker", None) is None:
552
773
            return
553
774
        logger.debug("Stopping checker for %(name)s", vars(self))
554
 
        try:
555
 
            os.kill(self.checker.pid, signal.SIGTERM)
556
 
            #time.sleep(0.5)
557
 
            #if self.checker.poll() is None:
558
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
559
 
        except OSError as error:
560
 
            if error.errno != errno.ESRCH: # No such process
561
 
                raise
 
775
        self.checker.terminate()
562
776
        self.checker = None
563
777
 
564
 
def dbus_service_property(dbus_interface, signature="v",
565
 
                          access="readwrite", byte_arrays=False):
 
778
 
 
779
def dbus_service_property(dbus_interface,
 
780
                          signature="v",
 
781
                          access="readwrite",
 
782
                          byte_arrays=False):
566
783
    """Decorators for marking methods of a DBusObjectWithProperties to
567
784
    become properties on the D-Bus.
568
785
    
577
794
    # "Set" method, so we fail early here:
578
795
    if byte_arrays and signature != "ay":
579
796
        raise ValueError("Byte arrays not supported for non-'ay'"
580
 
                         " signature %r" % signature)
 
797
                         " signature {!r}".format(signature))
 
798
    
581
799
    def decorator(func):
582
800
        func._dbus_is_property = True
583
801
        func._dbus_interface = dbus_interface
588
806
            func._dbus_name = func._dbus_name[:-14]
589
807
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
590
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
    
591
851
    return decorator
592
852
 
593
853
 
594
854
class DBusPropertyException(dbus.exceptions.DBusException):
595
855
    """A base class for D-Bus property-related exceptions
596
856
    """
597
 
    def __unicode__(self):
598
 
        return unicode(str(self))
 
857
    pass
599
858
 
600
859
 
601
860
class DBusPropertyAccessException(DBusPropertyException):
612
871
 
613
872
class DBusObjectWithProperties(dbus.service.Object):
614
873
    """A D-Bus object with properties.
615
 
 
 
874
    
616
875
    Classes inheriting from this can use the dbus_service_property
617
876
    decorator to expose methods as D-Bus properties.  It exposes the
618
877
    standard Get(), Set(), and GetAll() methods on the D-Bus.
619
878
    """
620
879
    
621
880
    @staticmethod
622
 
    def _is_dbus_property(obj):
623
 
        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)
624
889
    
625
 
    def _get_all_dbus_properties(self):
 
890
    def _get_all_dbus_things(self, thing):
626
891
        """Returns a generator of (name, attribute) pairs
627
892
        """
628
 
        return ((prop._dbus_name, prop)
629
 
                for name, prop in
630
 
                inspect.getmembers(self, self._is_dbus_property))
 
893
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
894
                 athing.__get__(self))
 
895
                for cls in self.__class__.__mro__
 
896
                for name, athing in
 
897
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
631
898
    
632
899
    def _get_dbus_property(self, interface_name, property_name):
633
900
        """Returns a bound method if one exists which is a D-Bus
634
901
        property with the specified name and interface.
635
902
        """
636
 
        for name in (property_name,
637
 
                     property_name + "_dbus_property"):
638
 
            prop = getattr(self, name, None)
639
 
            if (prop is None
640
 
                or not self._is_dbus_property(prop)
641
 
                or prop._dbus_name != property_name
642
 
                or (interface_name and prop._dbus_interface
643
 
                    and interface_name != prop._dbus_interface)):
644
 
                continue
645
 
            return prop
 
903
        for cls in self.__class__.__mro__:
 
904
            for name, value in inspect.getmembers(
 
905
                    cls, self._is_dbus_thing("property")):
 
906
                if (value._dbus_name == property_name
 
907
                    and value._dbus_interface == interface_name):
 
908
                    return value.__get__(self)
 
909
        
646
910
        # No such property
647
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
648
 
                                   + interface_name + "."
649
 
                                   + property_name)
 
911
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
912
            self.dbus_object_path, interface_name, property_name))
650
913
    
651
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
914
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
915
                         in_signature="ss",
652
916
                         out_signature="v")
653
917
    def Get(self, interface_name, property_name):
654
918
        """Standard D-Bus property Get() method, see D-Bus standard.
672
936
            # The byte_arrays option is not supported yet on
673
937
            # signatures other than "ay".
674
938
            if prop._dbus_signature != "ay":
675
 
                raise ValueError
676
 
            value = dbus.ByteArray(''.join(unichr(byte)
677
 
                                           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))
678
944
        prop(value)
679
945
    
680
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
946
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
947
                         in_signature="s",
681
948
                         out_signature="a{sv}")
682
949
    def GetAll(self, interface_name):
683
950
        """Standard D-Bus property GetAll() method, see D-Bus
684
951
        standard.
685
 
 
 
952
        
686
953
        Note: Will not include properties with access="write".
687
954
        """
688
 
        all = {}
689
 
        for name, prop in self._get_all_dbus_properties():
 
955
        properties = {}
 
956
        for name, prop in self._get_all_dbus_things("property"):
690
957
            if (interface_name
691
958
                and interface_name != prop._dbus_interface):
692
959
                # Interface non-empty but did not match
696
963
                continue
697
964
            value = prop()
698
965
            if not hasattr(value, "variant_level"):
699
 
                all[name] = value
 
966
                properties[name] = value
700
967
                continue
701
 
            all[name] = type(value)(value, variant_level=
702
 
                                    value.variant_level+1)
703
 
        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
704
979
    
705
980
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
706
981
                         out_signature="s",
707
982
                         path_keyword='object_path',
708
983
                         connection_keyword='connection')
709
984
    def Introspect(self, object_path, connection):
710
 
        """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.
711
988
        """
712
989
        xmlstring = dbus.service.Object.Introspect(self, object_path,
713
990
                                                   connection)
714
991
        try:
715
992
            document = xml.dom.minidom.parseString(xmlstring)
 
993
            
716
994
            def make_tag(document, name, prop):
717
995
                e = document.createElement("property")
718
996
                e.setAttribute("name", name)
719
997
                e.setAttribute("type", prop._dbus_signature)
720
998
                e.setAttribute("access", prop._dbus_access)
721
999
                return e
 
1000
            
722
1001
            for if_tag in document.getElementsByTagName("interface"):
 
1002
                # Add property tags
723
1003
                for tag in (make_tag(document, name, prop)
724
1004
                            for name, prop
725
 
                            in self._get_all_dbus_properties()
 
1005
                            in self._get_all_dbus_things("property")
726
1006
                            if prop._dbus_interface
727
1007
                            == if_tag.getAttribute("name")):
728
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)
729
1038
                # Add the names to the return values for the
730
1039
                # "org.freedesktop.DBus.Properties" methods
731
1040
                if (if_tag.getAttribute("name")
746
1055
        except (AttributeError, xml.dom.DOMException,
747
1056
                xml.parsers.expat.ExpatError) as error:
748
1057
            logger.error("Failed to override Introspection method",
749
 
                         error)
 
1058
                         exc_info=error)
750
1059
        return xmlstring
751
1060
 
752
1061
 
753
 
def datetime_to_dbus (dt, variant_level=0):
 
1062
def datetime_to_dbus(dt, variant_level=0):
754
1063
    """Convert a UTC datetime.datetime() to a D-Bus type."""
755
1064
    if dt is None:
756
1065
        return dbus.String("", variant_level = variant_level)
757
 
    return dbus.String(dt.isoformat(),
758
 
                       variant_level=variant_level)
759
 
 
 
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).
 
1091
    """
 
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):
 
1100
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1101
                # with the wrong interface name
 
1102
                if (not hasattr(attribute, "_dbus_interface")
 
1103
                    or not attribute._dbus_interface.startswith(
 
1104
                        orig_interface_name)):
 
1105
                    continue
 
1106
                # Create an alternate D-Bus interface name based on
 
1107
                # the current name
 
1108
                alt_interface = attribute._dbus_interface.replace(
 
1109
                    orig_interface_name, alt_interface_name)
 
1110
                interface_names.add(alt_interface)
 
1111
                # Is this a D-Bus signal?
 
1112
                if getattr(attribute, "_dbus_is_signal", False):
 
1113
                    if sys.version_info.major == 2:
 
1114
                        # Extract the original non-method undecorated
 
1115
                        # function by black magic
 
1116
                        nonmethod_func = (dict(
 
1117
                            zip(attribute.func_code.co_freevars,
 
1118
                                attribute.__closure__))
 
1119
                                          ["func"].cell_contents)
 
1120
                    else:
 
1121
                        nonmethod_func = attribute
 
1122
                    # Create a new, but exactly alike, function
 
1123
                    # object, and decorate it to be a new D-Bus signal
 
1124
                    # with the alternate D-Bus interface name
 
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
 
1148
                    # Define a creator of a function to call both the
 
1149
                    # original and alternate functions, so both the
 
1150
                    # original and alternate signals gets sent when
 
1151
                    # the function is called
 
1152
                    def fixscope(func1, func2):
 
1153
                        """This function is a scope container to pass
 
1154
                        func1 and func2 to the "call_both" function
 
1155
                        outside of its arguments"""
 
1156
                        
 
1157
                        def call_both(*args, **kwargs):
 
1158
                            """This function will emit two D-Bus
 
1159
                            signals by calling func1 and func2"""
 
1160
                            func1(*args, **kwargs)
 
1161
                            func2(*args, **kwargs)
 
1162
                        
 
1163
                        return call_both
 
1164
                    # Create the "call_both" function and add it to
 
1165
                    # the class
 
1166
                    attr[attrname] = fixscope(attribute, new_function)
 
1167
                # Is this a D-Bus method?
 
1168
                elif getattr(attribute, "_dbus_is_method", False):
 
1169
                    # Create a new, but exactly alike, function
 
1170
                    # object.  Decorate it to be a new D-Bus method
 
1171
                    # with the alternate D-Bus interface name.  Add it
 
1172
                    # to the class.
 
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
 
1189
                # Is this a D-Bus property?
 
1190
                elif getattr(attribute, "_dbus_is_property", False):
 
1191
                    # Create a new, but exactly alike, function
 
1192
                    # object, and decorate it to be a new D-Bus
 
1193
                    # property with the alternate D-Bus interface
 
1194
                    # name.  Add it to the class.
 
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"})
760
1252
class ClientDBus(Client, DBusObjectWithProperties):
761
1253
    """A Client class using D-Bus
762
1254
    
766
1258
    """
767
1259
    
768
1260
    runtime_expansions = (Client.runtime_expansions
769
 
                          + ("dbus_object_path",))
 
1261
                          + ("dbus_object_path", ))
 
1262
    
 
1263
    _interface = "se.recompile.Mandos.Client"
770
1264
    
771
1265
    # dbus.service.Object doesn't use super(), so we can't either.
772
1266
    
773
1267
    def __init__(self, bus = None, *args, **kwargs):
774
 
        self._approvals_pending = 0
775
1268
        self.bus = bus
776
1269
        Client.__init__(self, *args, **kwargs)
777
1270
        # Only now, when this client is initialized, can it show up on
778
1271
        # the D-Bus
779
 
        client_object_name = unicode(self.name).translate(
 
1272
        client_object_name = str(self.name).translate(
780
1273
            {ord("."): ord("_"),
781
1274
             ord("-"): ord("_")})
782
 
        self.dbus_object_path = (dbus.ObjectPath
783
 
                                 ("/clients/" + client_object_name))
 
1275
        self.dbus_object_path = dbus.ObjectPath(
 
1276
            "/clients/" + client_object_name)
784
1277
        DBusObjectWithProperties.__init__(self, self.bus,
785
1278
                                          self.dbus_object_path)
 
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):
 
1285
        """ Modify a variable so that it's a property which announces
 
1286
        its changes to DBus.
786
1287
        
787
 
    def notifychangeproperty(transform_func,
788
 
                             dbus_name, type_func=lambda x: x,
789
 
                             variant_level=1):
790
 
        """ Modify a variable so that its a property that announce its
791
 
        changes to DBus.
792
 
        transform_fun: Function that takes a value and transform it to
793
 
                       DBus type.
794
 
        dbus_name: DBus name of the variable
 
1288
        transform_fun: Function that takes a value and a variant_level
 
1289
                       and transforms it to a D-Bus type.
 
1290
        dbus_name: D-Bus name of the variable
795
1291
        type_func: Function that transform the value before sending it
796
 
                   to DBus
797
 
        variant_level: DBus variant level. default: 1
 
1292
                   to the D-Bus.  Default: no transform
 
1293
        variant_level: D-Bus variant level.  Default: 1
798
1294
        """
799
 
        real_value = [None,]
 
1295
        attrname = "_{}".format(dbus_name)
 
1296
        
800
1297
        def setter(self, value):
801
 
            old_value = real_value[0]
802
 
            real_value[0] = value
803
1298
            if hasattr(self, "dbus_object_path"):
804
 
                if type_func(old_value) != type_func(real_value[0]):
805
 
                    dbus_value = transform_func(type_func(real_value[0]),
806
 
                                                variant_level)
807
 
                    self.PropertyChanged(dbus.String(dbus_name),
808
 
                                         dbus_value)
809
 
 
810
 
        return property(lambda self: real_value[0], setter)
811
 
 
812
 
 
 
1299
                if (not hasattr(self, attrname) or
 
1300
                    type_func(getattr(self, attrname, None))
 
1301
                    != type_func(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())
 
1317
            setattr(self, attrname, value)
 
1318
        
 
1319
        return property(lambda self: getattr(self, attrname), setter)
 
1320
    
813
1321
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
814
1322
    approvals_pending = notifychangeproperty(dbus.Boolean,
815
1323
                                             "ApprovalPending",
817
1325
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
818
1326
    last_enabled = notifychangeproperty(datetime_to_dbus,
819
1327
                                        "LastEnabled")
820
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
821
 
                                   type_func = lambda checker: checker is not None)
 
1328
    checker = notifychangeproperty(
 
1329
        dbus.Boolean, "CheckerRunning",
 
1330
        type_func = lambda checker: checker is not None)
822
1331
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
823
1332
                                           "LastCheckedOK")
824
 
    last_approval_request = notifychangeproperty(datetime_to_dbus,
825
 
                                                 "LastApprovalRequest")
 
1333
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1334
                                               "LastCheckerStatus")
 
1335
    last_approval_request = notifychangeproperty(
 
1336
        datetime_to_dbus, "LastApprovalRequest")
826
1337
    approved_by_default = notifychangeproperty(dbus.Boolean,
827
1338
                                               "ApprovedByDefault")
828
 
    approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",
829
 
                                          type_func = _timedelta_to_milliseconds)
830
 
    approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",
831
 
                                             type_func = _timedelta_to_milliseconds)
 
1339
    approval_delay = notifychangeproperty(
 
1340
        dbus.UInt64, "ApprovalDelay",
 
1341
        type_func = lambda td: td.total_seconds() * 1000)
 
1342
    approval_duration = notifychangeproperty(
 
1343
        dbus.UInt64, "ApprovalDuration",
 
1344
        type_func = lambda td: td.total_seconds() * 1000)
832
1345
    host = notifychangeproperty(dbus.String, "Host")
833
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
834
 
                                   type_func = _timedelta_to_milliseconds)
835
 
    extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",
836
 
                                            type_func = _timedelta_to_milliseconds)
837
 
    interval = notifychangeproperty(dbus.UInt16, "Interval",
838
 
                                    type_func = _timedelta_to_milliseconds)
 
1346
    timeout = notifychangeproperty(
 
1347
        dbus.UInt64, "Timeout",
 
1348
        type_func = lambda td: td.total_seconds() * 1000)
 
1349
    extended_timeout = notifychangeproperty(
 
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)
839
1355
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1356
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1357
                                  invalidate_only=True)
840
1358
    
841
1359
    del notifychangeproperty
842
1360
    
849
1367
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
850
1368
        Client.__del__(self, *args, **kwargs)
851
1369
    
852
 
    def checker_callback(self, pid, condition, command,
853
 
                         *args, **kwargs):
854
 
        self.checker_callback_tag = None
855
 
        self.checker = None
856
 
        if os.WIFEXITED(condition):
857
 
            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:
858
1377
            # Emit D-Bus signal
859
1378
            self.CheckerCompleted(dbus.Int16(exitstatus),
860
 
                                  dbus.Int64(condition),
 
1379
                                  dbus.Int64(0),
861
1380
                                  dbus.String(command))
862
1381
        else:
863
1382
            # Emit D-Bus signal
864
1383
            self.CheckerCompleted(dbus.Int16(-1),
865
 
                                  dbus.Int64(condition),
 
1384
                                  dbus.Int64(
 
1385
                                      self.last_checker_signal),
866
1386
                                  dbus.String(command))
867
 
        
868
 
        return Client.checker_callback(self, pid, condition, command,
869
 
                                       *args, **kwargs)
870
 
 
 
1387
        return ret
 
1388
    
871
1389
    def start_checker(self, *args, **kwargs):
872
 
        old_checker = self.checker
873
 
        if self.checker is not None:
874
 
            old_checker_pid = self.checker.pid
875
 
        else:
876
 
            old_checker_pid = None
 
1390
        old_checker_pid = getattr(self.checker, "pid", None)
877
1391
        r = Client.start_checker(self, *args, **kwargs)
878
1392
        # Only if new checker process was started
879
1393
        if (self.checker is not None
883
1397
        return r
884
1398
    
885
1399
    def _reset_approved(self):
886
 
        self._approved = None
 
1400
        self.approved = None
887
1401
        return False
888
1402
    
889
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)
890
1407
        self.send_changedstate()
891
 
        self._approved = value
892
 
        gobject.timeout_add(_timedelta_to_milliseconds
893
 
                            (self.approval_duration),
894
 
                            self._reset_approved)
895
 
    
896
1408
    
897
1409
    ## D-Bus methods, signals & properties
898
 
    _interface = "se.bsnet.fukt.Mandos.Client"
 
1410
    
 
1411
    ## Interfaces
899
1412
    
900
1413
    ## Signals
901
1414
    
912
1425
        pass
913
1426
    
914
1427
    # PropertyChanged - signal
 
1428
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
915
1429
    @dbus.service.signal(_interface, signature="sv")
916
1430
    def PropertyChanged(self, property, value):
917
1431
        "D-Bus signal"
981
1495
        return dbus.Boolean(bool(self.approvals_pending))
982
1496
    
983
1497
    # ApprovedByDefault - property
984
 
    @dbus_service_property(_interface, signature="b",
 
1498
    @dbus_service_property(_interface,
 
1499
                           signature="b",
985
1500
                           access="readwrite")
986
1501
    def ApprovedByDefault_dbus_property(self, value=None):
987
1502
        if value is None:       # get
989
1504
        self.approved_by_default = bool(value)
990
1505
    
991
1506
    # ApprovalDelay - property
992
 
    @dbus_service_property(_interface, signature="t",
 
1507
    @dbus_service_property(_interface,
 
1508
                           signature="t",
993
1509
                           access="readwrite")
994
1510
    def ApprovalDelay_dbus_property(self, value=None):
995
1511
        if value is None:       # get
996
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1512
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1513
                               * 1000)
997
1514
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
998
1515
    
999
1516
    # ApprovalDuration - property
1000
 
    @dbus_service_property(_interface, signature="t",
 
1517
    @dbus_service_property(_interface,
 
1518
                           signature="t",
1001
1519
                           access="readwrite")
1002
1520
    def ApprovalDuration_dbus_property(self, value=None):
1003
1521
        if value is None:       # get
1004
 
            return dbus.UInt64(_timedelta_to_milliseconds(
1005
 
                    self.approval_duration))
 
1522
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1523
                               * 1000)
1006
1524
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1007
1525
    
1008
1526
    # Name - property
 
1527
    @dbus_annotations(
 
1528
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1009
1529
    @dbus_service_property(_interface, signature="s", access="read")
1010
1530
    def Name_dbus_property(self):
1011
1531
        return dbus.String(self.name)
1012
1532
    
1013
1533
    # Fingerprint - property
 
1534
    @dbus_annotations(
 
1535
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1014
1536
    @dbus_service_property(_interface, signature="s", access="read")
1015
1537
    def Fingerprint_dbus_property(self):
1016
1538
        return dbus.String(self.fingerprint)
1017
1539
    
1018
1540
    # Host - property
1019
 
    @dbus_service_property(_interface, signature="s",
 
1541
    @dbus_service_property(_interface,
 
1542
                           signature="s",
1020
1543
                           access="readwrite")
1021
1544
    def Host_dbus_property(self, value=None):
1022
1545
        if value is None:       # get
1023
1546
            return dbus.String(self.host)
1024
 
        self.host = value
 
1547
        self.host = str(value)
1025
1548
    
1026
1549
    # Created - property
 
1550
    @dbus_annotations(
 
1551
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1027
1552
    @dbus_service_property(_interface, signature="s", access="read")
1028
1553
    def Created_dbus_property(self):
1029
 
        return dbus.String(datetime_to_dbus(self.created))
 
1554
        return datetime_to_dbus(self.created)
1030
1555
    
1031
1556
    # LastEnabled - property
1032
1557
    @dbus_service_property(_interface, signature="s", access="read")
1034
1559
        return datetime_to_dbus(self.last_enabled)
1035
1560
    
1036
1561
    # Enabled - property
1037
 
    @dbus_service_property(_interface, signature="b",
 
1562
    @dbus_service_property(_interface,
 
1563
                           signature="b",
1038
1564
                           access="readwrite")
1039
1565
    def Enabled_dbus_property(self, value=None):
1040
1566
        if value is None:       # get
1045
1571
            self.disable()
1046
1572
    
1047
1573
    # LastCheckedOK - property
1048
 
    @dbus_service_property(_interface, signature="s",
 
1574
    @dbus_service_property(_interface,
 
1575
                           signature="s",
1049
1576
                           access="readwrite")
1050
1577
    def LastCheckedOK_dbus_property(self, value=None):
1051
1578
        if value is not None:
1053
1580
            return
1054
1581
        return datetime_to_dbus(self.last_checked_ok)
1055
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
    
1056
1588
    # Expires - property
1057
1589
    @dbus_service_property(_interface, signature="s", access="read")
1058
1590
    def Expires_dbus_property(self):
1064
1596
        return datetime_to_dbus(self.last_approval_request)
1065
1597
    
1066
1598
    # Timeout - property
1067
 
    @dbus_service_property(_interface, signature="t",
 
1599
    @dbus_service_property(_interface,
 
1600
                           signature="t",
1068
1601
                           access="readwrite")
1069
1602
    def Timeout_dbus_property(self, value=None):
1070
1603
        if value is None:       # get
1071
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1604
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1605
        old_timeout = self.timeout
1072
1606
        self.timeout = datetime.timedelta(0, 0, 0, value)
1073
 
        if getattr(self, "disable_initiator_tag", None) is None:
1074
 
            return
1075
 
        # Reschedule timeout
1076
 
        gobject.source_remove(self.disable_initiator_tag)
1077
 
        self.disable_initiator_tag = None
1078
 
        self.expires = None
1079
 
        time_to_die = (self.
1080
 
                       _timedelta_to_milliseconds((self
1081
 
                                                   .last_checked_ok
1082
 
                                                   + self.timeout)
1083
 
                                                  - datetime.datetime
1084
 
                                                  .utcnow()))
1085
 
        if time_to_die <= 0:
1086
 
            # The timeout has passed
1087
 
            self.disable()
1088
 
        else:
1089
 
            self.expires = (datetime.datetime.utcnow()
1090
 
                            + datetime.timedelta(milliseconds = time_to_die))
1091
 
            self.disable_initiator_tag = (gobject.timeout_add
1092
 
                                          (time_to_die, self.disable))
1093
 
 
 
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)
 
1622
    
1094
1623
    # ExtendedTimeout - property
1095
 
    @dbus_service_property(_interface, signature="t",
 
1624
    @dbus_service_property(_interface,
 
1625
                           signature="t",
1096
1626
                           access="readwrite")
1097
1627
    def ExtendedTimeout_dbus_property(self, value=None):
1098
1628
        if value is None:       # get
1099
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1629
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1630
                               * 1000)
1100
1631
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1101
 
 
 
1632
    
1102
1633
    # Interval - property
1103
 
    @dbus_service_property(_interface, signature="t",
 
1634
    @dbus_service_property(_interface,
 
1635
                           signature="t",
1104
1636
                           access="readwrite")
1105
1637
    def Interval_dbus_property(self, value=None):
1106
1638
        if value is None:       # get
1107
 
            return dbus.UInt64(self.interval_milliseconds())
 
1639
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1108
1640
        self.interval = datetime.timedelta(0, 0, 0, value)
1109
1641
        if getattr(self, "checker_initiator_tag", None) is None:
1110
1642
            return
1111
 
        # Reschedule checker run
1112
 
        gobject.source_remove(self.checker_initiator_tag)
1113
 
        self.checker_initiator_tag = (gobject.timeout_add
1114
 
                                      (value, self.start_checker))
1115
 
        self.start_checker()    # Start one now, too
1116
 
 
 
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
 
1649
    
1117
1650
    # Checker - property
1118
 
    @dbus_service_property(_interface, signature="s",
 
1651
    @dbus_service_property(_interface,
 
1652
                           signature="s",
1119
1653
                           access="readwrite")
1120
1654
    def Checker_dbus_property(self, value=None):
1121
1655
        if value is None:       # get
1122
1656
            return dbus.String(self.checker_command)
1123
 
        self.checker_command = value
 
1657
        self.checker_command = str(value)
1124
1658
    
1125
1659
    # CheckerRunning - property
1126
 
    @dbus_service_property(_interface, signature="b",
 
1660
    @dbus_service_property(_interface,
 
1661
                           signature="b",
1127
1662
                           access="readwrite")
1128
1663
    def CheckerRunning_dbus_property(self, value=None):
1129
1664
        if value is None:       # get
1134
1669
            self.stop_checker()
1135
1670
    
1136
1671
    # ObjectPath - property
 
1672
    @dbus_annotations(
 
1673
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1137
1674
    @dbus_service_property(_interface, signature="o", access="read")
1138
1675
    def ObjectPath_dbus_property(self):
1139
1676
        return self.dbus_object_path # is already a dbus.ObjectPath
1140
1677
    
1141
1678
    # Secret = property
1142
 
    @dbus_service_property(_interface, signature="ay",
1143
 
                           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)
1144
1686
    def Secret_dbus_property(self, value):
1145
 
        self.secret = str(value)
 
1687
        self.secret = bytes(value)
1146
1688
    
1147
1689
    del _interface
1148
1690
 
1152
1694
        self._pipe = child_pipe
1153
1695
        self._pipe.send(('init', fpr, address))
1154
1696
        if not self._pipe.recv():
1155
 
            raise KeyError()
1156
 
 
 
1697
            raise KeyError(fpr)
 
1698
    
1157
1699
    def __getattribute__(self, name):
1158
 
        if(name == '_pipe'):
 
1700
        if name == '_pipe':
1159
1701
            return super(ProxyClient, self).__getattribute__(name)
1160
1702
        self._pipe.send(('getattr', name))
1161
1703
        data = self._pipe.recv()
1162
1704
        if data[0] == 'data':
1163
1705
            return data[1]
1164
1706
        if data[0] == 'function':
 
1707
            
1165
1708
            def func(*args, **kwargs):
1166
1709
                self._pipe.send(('funcall', name, args, kwargs))
1167
1710
                return self._pipe.recv()[1]
 
1711
            
1168
1712
            return func
1169
 
 
 
1713
    
1170
1714
    def __setattr__(self, name, value):
1171
 
        if(name == '_pipe'):
 
1715
        if name == '_pipe':
1172
1716
            return super(ProxyClient, self).__setattr__(name, value)
1173
1717
        self._pipe.send(('setattr', name, value))
1174
1718
 
1182
1726
    def handle(self):
1183
1727
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1184
1728
            logger.info("TCP connection from: %s",
1185
 
                        unicode(self.client_address))
 
1729
                        str(self.client_address))
1186
1730
            logger.debug("Pipe FD: %d",
1187
1731
                         self.server.child_pipe.fileno())
1188
 
 
1189
 
            session = (gnutls.connection
1190
 
                       .ClientSession(self.request,
1191
 
                                      gnutls.connection
1192
 
                                      .X509Credentials()))
1193
 
 
 
1732
            
 
1733
            session = gnutls.connection.ClientSession(
 
1734
                self.request, gnutls.connection .X509Credentials())
 
1735
            
1194
1736
            # Note: gnutls.connection.X509Credentials is really a
1195
1737
            # generic GnuTLS certificate credentials object so long as
1196
1738
            # no X.509 keys are added to it.  Therefore, we can use it
1197
1739
            # here despite using OpenPGP certificates.
1198
 
 
 
1740
            
1199
1741
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1200
1742
            #                      "+AES-256-CBC", "+SHA1",
1201
1743
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1204
1746
            priority = self.server.gnutls_priority
1205
1747
            if priority is None:
1206
1748
                priority = "NORMAL"
1207
 
            (gnutls.library.functions
1208
 
             .gnutls_priority_set_direct(session._c_object,
1209
 
                                         priority, None))
1210
 
 
 
1749
            gnutls.library.functions.gnutls_priority_set_direct(
 
1750
                session._c_object, priority, None)
 
1751
            
1211
1752
            # Start communication using the Mandos protocol
1212
1753
            # Get protocol number
1213
1754
            line = self.request.makefile().readline()
1214
1755
            logger.debug("Protocol version: %r", line)
1215
1756
            try:
1216
1757
                if int(line.strip().split()[0]) > 1:
1217
 
                    raise RuntimeError
 
1758
                    raise RuntimeError(line)
1218
1759
            except (ValueError, IndexError, RuntimeError) as error:
1219
1760
                logger.error("Unknown protocol version: %s", error)
1220
1761
                return
1221
 
 
 
1762
            
1222
1763
            # Start GnuTLS connection
1223
1764
            try:
1224
1765
                session.handshake()
1228
1769
                # established.  Just abandon the request.
1229
1770
                return
1230
1771
            logger.debug("Handshake succeeded")
1231
 
 
 
1772
            
1232
1773
            approval_required = False
1233
1774
            try:
1234
1775
                try:
1235
 
                    fpr = self.fingerprint(self.peer_certificate
1236
 
                                           (session))
 
1776
                    fpr = self.fingerprint(
 
1777
                        self.peer_certificate(session))
1237
1778
                except (TypeError,
1238
1779
                        gnutls.errors.GNUTLSError) as error:
1239
1780
                    logger.warning("Bad certificate: %s", error)
1240
1781
                    return
1241
1782
                logger.debug("Fingerprint: %s", fpr)
1242
 
 
 
1783
                
1243
1784
                try:
1244
1785
                    client = ProxyClient(child_pipe, fpr,
1245
1786
                                         self.client_address)
1254
1795
                while True:
1255
1796
                    if not client.enabled:
1256
1797
                        logger.info("Client %s is disabled",
1257
 
                                       client.name)
 
1798
                                    client.name)
1258
1799
                        if self.server.use_dbus:
1259
1800
                            # Emit D-Bus signal
1260
 
                            client.Rejected("Disabled")                    
 
1801
                            client.Rejected("Disabled")
1261
1802
                        return
1262
1803
                    
1263
 
                    if client._approved or not client.approval_delay:
 
1804
                    if client.approved or not client.approval_delay:
1264
1805
                        #We are approved or approval is disabled
1265
1806
                        break
1266
 
                    elif client._approved is None:
 
1807
                    elif client.approved is None:
1267
1808
                        logger.info("Client %s needs approval",
1268
1809
                                    client.name)
1269
1810
                        if self.server.use_dbus:
1270
1811
                            # Emit D-Bus signal
1271
1812
                            client.NeedApproval(
1272
 
                                client.approval_delay_milliseconds(),
1273
 
                                client.approved_by_default)
 
1813
                                client.approval_delay.total_seconds()
 
1814
                                * 1000, client.approved_by_default)
1274
1815
                    else:
1275
1816
                        logger.warning("Client %s was not approved",
1276
1817
                                       client.name)
1280
1821
                        return
1281
1822
                    
1282
1823
                    #wait until timeout or approved
1283
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1284
1824
                    time = datetime.datetime.now()
1285
1825
                    client.changedstate.acquire()
1286
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1826
                    client.changedstate.wait(delay.total_seconds())
1287
1827
                    client.changedstate.release()
1288
1828
                    time2 = datetime.datetime.now()
1289
1829
                    if (time2 - time) >= delay:
1305
1845
                    try:
1306
1846
                        sent = session.send(client.secret[sent_size:])
1307
1847
                    except gnutls.errors.GNUTLSError as error:
1308
 
                        logger.warning("gnutls send failed")
 
1848
                        logger.warning("gnutls send failed",
 
1849
                                       exc_info=error)
1309
1850
                        return
1310
 
                    logger.debug("Sent: %d, remaining: %d",
1311
 
                                 sent, len(client.secret)
1312
 
                                 - (sent_size + sent))
 
1851
                    logger.debug("Sent: %d, remaining: %d", sent,
 
1852
                                 len(client.secret) - (sent_size
 
1853
                                                       + sent))
1313
1854
                    sent_size += sent
1314
 
 
 
1855
                
1315
1856
                logger.info("Sending secret to %s", client.name)
1316
 
                # bump the timeout as if seen
1317
 
                client.checked_ok(client.extended_timeout)
 
1857
                # bump the timeout using extended_timeout
 
1858
                client.bump_timeout(client.extended_timeout)
1318
1859
                if self.server.use_dbus:
1319
1860
                    # Emit D-Bus signal
1320
1861
                    client.GotSecret()
1325
1866
                try:
1326
1867
                    session.bye()
1327
1868
                except gnutls.errors.GNUTLSError as error:
1328
 
                    logger.warning("GnuTLS bye failed")
 
1869
                    logger.warning("GnuTLS bye failed",
 
1870
                                   exc_info=error)
1329
1871
    
1330
1872
    @staticmethod
1331
1873
    def peer_certificate(session):
1332
1874
        "Return the peer's OpenPGP certificate as a bytestring"
1333
1875
        # If not an OpenPGP certificate...
1334
 
        if (gnutls.library.functions
1335
 
            .gnutls_certificate_type_get(session._c_object)
 
1876
        if (gnutls.library.functions.gnutls_certificate_type_get(
 
1877
                session._c_object)
1336
1878
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1337
1879
            # ...do the normal thing
1338
1880
            return session.peer_certificate
1352
1894
    def fingerprint(openpgp):
1353
1895
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1354
1896
        # New GnuTLS "datum" with the OpenPGP public key
1355
 
        datum = (gnutls.library.types
1356
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1357
 
                                             ctypes.POINTER
1358
 
                                             (ctypes.c_ubyte)),
1359
 
                                 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)))
1360
1901
        # New empty GnuTLS certificate
1361
1902
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1362
 
        (gnutls.library.functions
1363
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
1903
        gnutls.library.functions.gnutls_openpgp_crt_init(
 
1904
            ctypes.byref(crt))
1364
1905
        # Import the OpenPGP public key into the certificate
1365
 
        (gnutls.library.functions
1366
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1367
 
                                    gnutls.library.constants
1368
 
                                    .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)
1369
1909
        # Verify the self signature in the key
1370
1910
        crtverify = ctypes.c_uint()
1371
 
        (gnutls.library.functions
1372
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1373
 
                                         ctypes.byref(crtverify)))
 
1911
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
 
1912
            crt, 0, ctypes.byref(crtverify))
1374
1913
        if crtverify.value != 0:
1375
1914
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1376
 
            raise (gnutls.errors.CertificateSecurityError
1377
 
                   ("Verify failed"))
 
1915
            raise gnutls.errors.CertificateSecurityError(
 
1916
                "Verify failed")
1378
1917
        # New buffer for the fingerprint
1379
1918
        buf = ctypes.create_string_buffer(20)
1380
1919
        buf_len = ctypes.c_size_t()
1381
1920
        # Get the fingerprint from the certificate into the buffer
1382
 
        (gnutls.library.functions
1383
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1384
 
                                             ctypes.byref(buf_len)))
 
1921
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
 
1922
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
1385
1923
        # Deinit the certificate
1386
1924
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1387
1925
        # Convert the buffer to a Python bytestring
1388
1926
        fpr = ctypes.string_at(buf, buf_len.value)
1389
1927
        # Convert the bytestring to hexadecimal notation
1390
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1928
        hex_fpr = binascii.hexlify(fpr).upper()
1391
1929
        return hex_fpr
1392
1930
 
1393
1931
 
1394
1932
class MultiprocessingMixIn(object):
1395
1933
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1934
    
1396
1935
    def sub_process_main(self, request, address):
1397
1936
        try:
1398
1937
            self.finish_request(request, address)
1399
 
        except:
 
1938
        except Exception:
1400
1939
            self.handle_error(request, address)
1401
1940
        self.close_request(request)
1402
 
            
 
1941
    
1403
1942
    def process_request(self, request, address):
1404
1943
        """Start a new process to process the request."""
1405
 
        multiprocessing.Process(target = self.sub_process_main,
1406
 
                                args = (request, address)).start()
 
1944
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1945
                                       args = (request, address))
 
1946
        proc.start()
 
1947
        return proc
 
1948
 
1407
1949
 
1408
1950
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1409
1951
    """ adds a pipe to the MixIn """
 
1952
    
1410
1953
    def process_request(self, request, client_address):
1411
1954
        """Overrides and wraps the original process_request().
1412
1955
        
1413
1956
        This function creates a new pipe in self.pipe
1414
1957
        """
1415
1958
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1416
 
 
1417
 
        super(MultiprocessingMixInWithPipe,
1418
 
              self).process_request(request, client_address)
 
1959
        
 
1960
        proc = MultiprocessingMixIn.process_request(self, request,
 
1961
                                                    client_address)
1419
1962
        self.child_pipe.close()
1420
 
        self.add_pipe(parent_pipe)
1421
 
 
1422
 
    def add_pipe(self, parent_pipe):
 
1963
        self.add_pipe(parent_pipe, proc)
 
1964
    
 
1965
    def add_pipe(self, parent_pipe, proc):
1423
1966
        """Dummy function; override as necessary"""
1424
 
        raise NotImplementedError
 
1967
        raise NotImplementedError()
 
1968
 
1425
1969
 
1426
1970
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1427
1971
                     socketserver.TCPServer, object):
1432
1976
        interface:      None or a network interface name (string)
1433
1977
        use_ipv6:       Boolean; to use IPv6 or not
1434
1978
    """
 
1979
    
1435
1980
    def __init__(self, server_address, RequestHandlerClass,
1436
 
                 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
        """
1437
1987
        self.interface = interface
1438
1988
        if use_ipv6:
1439
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.
1440
2016
        socketserver.TCPServer.__init__(self, server_address,
1441
2017
                                        RequestHandlerClass)
 
2018
    
1442
2019
    def server_bind(self):
1443
2020
        """This overrides the normal server_bind() function
1444
2021
        to bind to an interface if one was specified, and also NOT to
1450
2027
                             self.interface)
1451
2028
            else:
1452
2029
                try:
1453
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1454
 
                                           SO_BINDTODEVICE,
1455
 
                                           str(self.interface
1456
 
                                               + '\0'))
 
2030
                    self.socket.setsockopt(
 
2031
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2032
                        (self.interface + "\0").encode("utf-8"))
1457
2033
                except socket.error as error:
1458
 
                    if error[0] == errno.EPERM:
1459
 
                        logger.error("No permission to"
1460
 
                                     " bind to interface %s",
1461
 
                                     self.interface)
1462
 
                    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:
1463
2038
                        logger.error("SO_BINDTODEVICE not available;"
1464
2039
                                     " cannot bind to interface %s",
1465
2040
                                     self.interface)
 
2041
                    elif error.errno == errno.ENODEV:
 
2042
                        logger.error("Interface %s does not exist,"
 
2043
                                     " cannot bind", self.interface)
1466
2044
                    else:
1467
2045
                        raise
1468
2046
        # Only bind(2) the socket if we really need to.
1471
2049
                if self.address_family == socket.AF_INET6:
1472
2050
                    any_address = "::" # in6addr_any
1473
2051
                else:
1474
 
                    any_address = socket.INADDR_ANY
 
2052
                    any_address = "0.0.0.0" # INADDR_ANY
1475
2053
                self.server_address = (any_address,
1476
2054
                                       self.server_address[1])
1477
2055
            elif not self.server_address[1]:
1478
 
                self.server_address = (self.server_address[0],
1479
 
                                       0)
 
2056
                self.server_address = (self.server_address[0], 0)
1480
2057
#                 if self.interface:
1481
2058
#                     self.server_address = (self.server_address[0],
1482
2059
#                                            0, # port
1496
2073
    
1497
2074
    Assumes a gobject.MainLoop event loop.
1498
2075
    """
 
2076
    
1499
2077
    def __init__(self, server_address, RequestHandlerClass,
1500
 
                 interface=None, use_ipv6=True, clients=None,
1501
 
                 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):
1502
2084
        self.enabled = False
1503
2085
        self.clients = clients
1504
2086
        if self.clients is None:
1505
 
            self.clients = set()
 
2087
            self.clients = {}
1506
2088
        self.use_dbus = use_dbus
1507
2089
        self.gnutls_priority = gnutls_priority
1508
2090
        IPv6_TCPServer.__init__(self, server_address,
1509
2091
                                RequestHandlerClass,
1510
2092
                                interface = interface,
1511
 
                                use_ipv6 = use_ipv6)
 
2093
                                use_ipv6 = use_ipv6,
 
2094
                                socketfd = socketfd)
 
2095
    
1512
2096
    def server_activate(self):
1513
2097
        if self.enabled:
1514
2098
            return socketserver.TCPServer.server_activate(self)
 
2099
    
1515
2100
    def enable(self):
1516
2101
        self.enabled = True
1517
 
    def add_pipe(self, parent_pipe):
 
2102
    
 
2103
    def add_pipe(self, parent_pipe, proc):
1518
2104
        # Call "handle_ipc" for both data and EOF events
1519
 
        gobject.io_add_watch(parent_pipe.fileno(),
1520
 
                             gobject.IO_IN | gobject.IO_HUP,
1521
 
                             functools.partial(self.handle_ipc,
1522
 
                                               parent_pipe = parent_pipe))
1523
 
        
1524
 
    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,
1525
2115
                   client_object=None):
1526
 
        condition_names = {
1527
 
            gobject.IO_IN: "IN",   # There is data to read.
1528
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1529
 
                                    # blocking).
1530
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1531
 
            gobject.IO_ERR: "ERR", # Error condition.
1532
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1533
 
                                    # broken, usually for pipes and
1534
 
                                    # sockets).
1535
 
            }
1536
 
        conditions_string = ' | '.join(name
1537
 
                                       for cond, name in
1538
 
                                       condition_names.iteritems()
1539
 
                                       if cond & condition)
1540
 
        # error or the other end of multiprocessing.Pipe has closed
1541
 
        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()
1542
2120
            return False
1543
2121
        
1544
2122
        # Read a request from the child
1549
2127
            fpr = request[1]
1550
2128
            address = request[2]
1551
2129
            
1552
 
            for c in self.clients:
 
2130
            for c in self.clients.itervalues():
1553
2131
                if c.fingerprint == fpr:
1554
2132
                    client = c
1555
2133
                    break
1558
2136
                            "dress: %s", fpr, address)
1559
2137
                if self.use_dbus:
1560
2138
                    # Emit D-Bus signal
1561
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2139
                    mandos_dbus_service.ClientNotFound(fpr,
 
2140
                                                       address[0])
1562
2141
                parent_pipe.send(False)
1563
2142
                return False
1564
2143
            
1565
 
            gobject.io_add_watch(parent_pipe.fileno(),
1566
 
                                 gobject.IO_IN | gobject.IO_HUP,
1567
 
                                 functools.partial(self.handle_ipc,
1568
 
                                                   parent_pipe = parent_pipe,
1569
 
                                                   client_object = 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))
1570
2151
            parent_pipe.send(True)
1571
 
            # remove the old hook in favor of the new above hook on same fileno
 
2152
            # remove the old hook in favor of the new above hook on
 
2153
            # same fileno
1572
2154
            return False
1573
2155
        if command == 'funcall':
1574
2156
            funcname = request[1]
1575
2157
            args = request[2]
1576
2158
            kwargs = request[3]
1577
2159
            
1578
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1579
 
 
 
2160
            parent_pipe.send(('data', getattr(client_object,
 
2161
                                              funcname)(*args,
 
2162
                                                        **kwargs)))
 
2163
        
1580
2164
        if command == 'getattr':
1581
2165
            attrname = request[1]
1582
 
            if callable(client_object.__getattribute__(attrname)):
1583
 
                parent_pipe.send(('function',))
 
2166
            if isinstance(client_object.__getattribute__(attrname),
 
2167
                          collections.Callable):
 
2168
                parent_pipe.send(('function', ))
1584
2169
            else:
1585
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2170
                parent_pipe.send((
 
2171
                    'data', client_object.__getattribute__(attrname)))
1586
2172
        
1587
2173
        if command == 'setattr':
1588
2174
            attrname = request[1]
1589
2175
            value = request[2]
1590
2176
            setattr(client_object, attrname, value)
1591
 
 
 
2177
        
1592
2178
        return True
1593
2179
 
1594
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
 
1595
2277
def string_to_delta(interval):
1596
2278
    """Parse a string and return a datetime.timedelta
1597
2279
    
1608
2290
    >>> string_to_delta('5m 30s')
1609
2291
    datetime.timedelta(0, 330)
1610
2292
    """
 
2293
    
 
2294
    try:
 
2295
        return rfc3339_duration_to_delta(interval)
 
2296
    except ValueError:
 
2297
        pass
 
2298
    
1611
2299
    timevalue = datetime.timedelta(0)
1612
2300
    for s in interval.split():
1613
2301
        try:
1614
 
            suffix = unicode(s[-1])
 
2302
            suffix = s[-1]
1615
2303
            value = int(s[:-1])
1616
2304
            if suffix == "d":
1617
2305
                delta = datetime.timedelta(value)
1624
2312
            elif suffix == "w":
1625
2313
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1626
2314
            else:
1627
 
                raise ValueError("Unknown suffix %r" % suffix)
1628
 
        except (ValueError, IndexError) as e:
 
2315
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2316
        except IndexError as e:
1629
2317
            raise ValueError(*(e.args))
1630
2318
        timevalue += delta
1631
2319
    return timevalue
1632
2320
 
1633
2321
 
1634
 
def if_nametoindex(interface):
1635
 
    """Call the C function if_nametoindex(), or equivalent
1636
 
    
1637
 
    Note: This function cannot accept a unicode string."""
1638
 
    global if_nametoindex
1639
 
    try:
1640
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1641
 
                          (ctypes.util.find_library("c"))
1642
 
                          .if_nametoindex)
1643
 
    except (OSError, AttributeError):
1644
 
        logger.warning("Doing if_nametoindex the hard way")
1645
 
        def if_nametoindex(interface):
1646
 
            "Get an interface index the hard way, i.e. using fcntl()"
1647
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1648
 
            with contextlib.closing(socket.socket()) as s:
1649
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1650
 
                                    struct.pack(str("16s16x"),
1651
 
                                                interface))
1652
 
            interface_index = struct.unpack(str("I"),
1653
 
                                            ifreq[16:20])[0]
1654
 
            return interface_index
1655
 
    return if_nametoindex(interface)
1656
 
 
1657
 
 
1658
2322
def daemon(nochdir = False, noclose = False):
1659
2323
    """See daemon(3).  Standard BSD Unix function.
1660
2324
    
1668
2332
        sys.exit()
1669
2333
    if not noclose:
1670
2334
        # Close all standard open file descriptors
1671
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2335
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1672
2336
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1673
2337
            raise OSError(errno.ENODEV,
1674
 
                          "%s not a character device"
1675
 
                          % os.path.devnull)
 
2338
                          "{} not a character device"
 
2339
                          .format(os.devnull))
1676
2340
        os.dup2(null, sys.stdin.fileno())
1677
2341
        os.dup2(null, sys.stdout.fileno())
1678
2342
        os.dup2(null, sys.stderr.fileno())
1687
2351
    
1688
2352
    parser = argparse.ArgumentParser()
1689
2353
    parser.add_argument("-v", "--version", action="version",
1690
 
                        version = "%%(prog)s %s" % version,
 
2354
                        version = "%(prog)s {}".format(version),
1691
2355
                        help="show version number and exit")
1692
2356
    parser.add_argument("-i", "--interface", metavar="IF",
1693
2357
                        help="Bind to interface IF")
1699
2363
                        help="Run self-test")
1700
2364
    parser.add_argument("--debug", action="store_true",
1701
2365
                        help="Debug mode; run in foreground and log"
1702
 
                        " to terminal")
 
2366
                        " to terminal", default=None)
1703
2367
    parser.add_argument("--debuglevel", metavar="LEVEL",
1704
2368
                        help="Debug level for stdout output")
1705
2369
    parser.add_argument("--priority", help="GnuTLS"
1712
2376
                        " files")
1713
2377
    parser.add_argument("--no-dbus", action="store_false",
1714
2378
                        dest="use_dbus", help="Do not provide D-Bus"
1715
 
                        " system bus interface")
 
2379
                        " system bus interface", default=None)
1716
2380
    parser.add_argument("--no-ipv6", action="store_false",
1717
 
                        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
    
1718
2397
    options = parser.parse_args()
1719
2398
    
1720
2399
    if options.check:
1721
2400
        import doctest
1722
 
        doctest.testmod()
1723
 
        sys.exit()
 
2401
        fail_count, test_count = doctest.testmod()
 
2402
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1724
2403
    
1725
2404
    # Default values for config file for server-global settings
1726
2405
    server_defaults = { "interface": "",
1728
2407
                        "port": "",
1729
2408
                        "debug": "False",
1730
2409
                        "priority":
1731
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2410
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2411
                        ":+SIGN-DSA-SHA256",
1732
2412
                        "servicename": "Mandos",
1733
2413
                        "use_dbus": "True",
1734
2414
                        "use_ipv6": "True",
1735
2415
                        "debuglevel": "",
1736
 
                        }
 
2416
                        "restore": "True",
 
2417
                        "socket": "",
 
2418
                        "statedir": "/var/lib/mandos",
 
2419
                        "foreground": "False",
 
2420
                        "zeroconf": "True",
 
2421
                    }
1737
2422
    
1738
2423
    # Parse config file for server-global settings
1739
2424
    server_config = configparser.SafeConfigParser(server_defaults)
1740
2425
    del server_defaults
1741
 
    server_config.read(os.path.join(options.configdir,
1742
 
                                    "mandos.conf"))
 
2426
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
1743
2427
    # Convert the SafeConfigParser object to a dict
1744
2428
    server_settings = server_config.defaults()
1745
2429
    # Use the appropriate methods on the non-string config options
1746
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2430
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1747
2431
        server_settings[option] = server_config.getboolean("DEFAULT",
1748
2432
                                                           option)
1749
2433
    if server_settings["port"]:
1750
2434
        server_settings["port"] = server_config.getint("DEFAULT",
1751
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"])
1752
2445
    del server_config
1753
2446
    
1754
2447
    # Override the settings from the config file with command line
1755
2448
    # options, if set.
1756
2449
    for option in ("interface", "address", "port", "debug",
1757
 
                   "priority", "servicename", "configdir",
1758
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2450
                   "priority", "servicename", "configdir", "use_dbus",
 
2451
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2452
                   "socket", "foreground", "zeroconf"):
1759
2453
        value = getattr(options, option)
1760
2454
        if value is not None:
1761
2455
            server_settings[option] = value
1762
2456
    del options
1763
2457
    # Force all strings to be unicode
1764
2458
    for option in server_settings.keys():
1765
 
        if type(server_settings[option]) is str:
1766
 
            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
1767
2469
    # Now we have our good server settings in "server_settings"
1768
2470
    
1769
2471
    ##################################################################
1770
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
    
1771
2478
    # For convenience
1772
2479
    debug = server_settings["debug"]
1773
2480
    debuglevel = server_settings["debuglevel"]
1774
2481
    use_dbus = server_settings["use_dbus"]
1775
2482
    use_ipv6 = server_settings["use_ipv6"]
1776
 
 
 
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)
 
2496
    
1777
2497
    if server_settings["servicename"] != "Mandos":
1778
 
        syslogger.setFormatter(logging.Formatter
1779
 
                               ('Mandos (%s) [%%(process)d]:'
1780
 
                                ' %%(levelname)s: %%(message)s'
1781
 
                                % server_settings["servicename"]))
 
2498
        syslogger.setFormatter(
 
2499
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2500
                              ' %(levelname)s: %(message)s'.format(
 
2501
                                  server_settings["servicename"])))
1782
2502
    
1783
2503
    # Parse config file with clients
1784
 
    client_defaults = { "timeout": "5m",
1785
 
                        "extended_timeout": "15m",
1786
 
                        "interval": "2m",
1787
 
                        "checker": "fping -q -- %%(host)s",
1788
 
                        "host": "",
1789
 
                        "approval_delay": "0s",
1790
 
                        "approval_duration": "1s",
1791
 
                        }
1792
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2504
    client_config = configparser.SafeConfigParser(Client
 
2505
                                                  .client_defaults)
1793
2506
    client_config.read(os.path.join(server_settings["configdir"],
1794
2507
                                    "clients.conf"))
1795
2508
    
1796
2509
    global mandos_dbus_service
1797
2510
    mandos_dbus_service = None
1798
2511
    
1799
 
    tcp_server = MandosServer((server_settings["address"],
1800
 
                               server_settings["port"]),
1801
 
                              ClientHandler,
1802
 
                              interface=(server_settings["interface"]
1803
 
                                         or None),
1804
 
                              use_ipv6=use_ipv6,
1805
 
                              gnutls_priority=
1806
 
                              server_settings["priority"],
1807
 
                              use_dbus=use_dbus)
1808
 
    if not debug:
1809
 
        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
1810
2528
        try:
1811
 
            pidfile = open(pidfilename, "w")
1812
 
        except IOError:
1813
 
            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)
1814
2533
    
1815
 
    try:
1816
 
        uid = pwd.getpwnam("_mandos").pw_uid
1817
 
        gid = pwd.getpwnam("_mandos").pw_gid
1818
 
    except KeyError:
 
2534
    for name in ("_mandos", "mandos", "nobody"):
1819
2535
        try:
1820
 
            uid = pwd.getpwnam("mandos").pw_uid
1821
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2536
            uid = pwd.getpwnam(name).pw_uid
 
2537
            gid = pwd.getpwnam(name).pw_gid
 
2538
            break
1822
2539
        except KeyError:
1823
 
            try:
1824
 
                uid = pwd.getpwnam("nobody").pw_uid
1825
 
                gid = pwd.getpwnam("nobody").pw_gid
1826
 
            except KeyError:
1827
 
                uid = 65534
1828
 
                gid = 65534
 
2540
            continue
 
2541
    else:
 
2542
        uid = 65534
 
2543
        gid = 65534
1829
2544
    try:
1830
2545
        os.setgid(gid)
1831
2546
        os.setuid(uid)
1832
2547
    except OSError as error:
1833
 
        if error[0] != errno.EPERM:
1834
 
            raise error
 
2548
        if error.errno != errno.EPERM:
 
2549
            raise
1835
2550
    
1836
 
    if not debug and not debuglevel:
1837
 
        syslogger.setLevel(logging.WARNING)
1838
 
        console.setLevel(logging.WARNING)
1839
 
    if debuglevel:
1840
 
        level = getattr(logging, debuglevel.upper())
1841
 
        syslogger.setLevel(level)
1842
 
        console.setLevel(level)
1843
 
 
1844
2551
    if debug:
1845
2552
        # Enable all possible GnuTLS debugging
1846
2553
        
1852
2559
        def debug_gnutls(level, string):
1853
2560
            logger.debug("GnuTLS: %s", string[:-1])
1854
2561
        
1855
 
        (gnutls.library.functions
1856
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2562
        gnutls.library.functions.gnutls_global_set_log_function(
 
2563
            debug_gnutls)
1857
2564
        
1858
2565
        # Redirect stdin so all checkers get /dev/null
1859
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2566
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1860
2567
        os.dup2(null, sys.stdin.fileno())
1861
2568
        if null > 2:
1862
2569
            os.close(null)
1863
 
    else:
1864
 
        # No console logging
1865
 
        logger.removeHandler(console)
1866
2570
    
1867
2571
    # Need to fork before connecting to D-Bus
1868
 
    if not debug:
 
2572
    if not foreground:
1869
2573
        # Close all input and output, do double fork, etc.
1870
2574
        daemon()
1871
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
    
1872
2580
    global main_loop
1873
2581
    # From the Avahi example code
1874
 
    DBusGMainLoop(set_as_default=True )
 
2582
    DBusGMainLoop(set_as_default=True)
1875
2583
    main_loop = gobject.MainLoop()
1876
2584
    bus = dbus.SystemBus()
1877
2585
    # End of Avahi example code
1878
2586
    if use_dbus:
1879
2587
        try:
1880
 
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1881
 
                                            bus, do_not_queue=True)
1882
 
        except dbus.exceptions.NameExistsException as e:
1883
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2588
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
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)
1884
2596
            use_dbus = False
1885
2597
            server_settings["use_dbus"] = False
1886
2598
            tcp_server.use_dbus = False
1887
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1888
 
    service = AvahiService(name = server_settings["servicename"],
1889
 
                           servicetype = "_mandos._tcp",
1890
 
                           protocol = protocol, bus = bus)
1891
 
    if server_settings["interface"]:
1892
 
        service.interface = (if_nametoindex
1893
 
                             (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"))
1894
2609
    
1895
2610
    global multiprocessing_manager
1896
2611
    multiprocessing_manager = multiprocessing.Manager()
1898
2613
    client_class = Client
1899
2614
    if use_dbus:
1900
2615
        client_class = functools.partial(ClientDBus, bus = bus)
1901
 
    def client_config_items(config, section):
1902
 
        special_settings = {
1903
 
            "approved_by_default":
1904
 
                lambda: config.getboolean(section,
1905
 
                                          "approved_by_default"),
1906
 
            }
1907
 
        for name, value in config.items(section):
 
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))
1908
2700
            try:
1909
 
                yield (name, special_settings[name]())
1910
 
            except KeyError:
1911
 
                yield (name, value)
1912
 
    
1913
 
    tcp_server.clients.update(set(
1914
 
            client_class(name = section,
1915
 
                         config= dict(client_config_items(
1916
 
                        client_config, section)))
1917
 
            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
    
1918
2726
    if not tcp_server.clients:
1919
2727
        logger.warning("No clients defined")
1920
 
        
1921
 
    if not debug:
1922
 
        try:
1923
 
            with pidfile:
1924
 
                pid = os.getpid()
1925
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
1926
 
            del pidfile
1927
 
        except IOError:
1928
 
            logger.error("Could not write to file %r with PID %d",
1929
 
                         pidfilename, pid)
1930
 
        except NameError:
1931
 
            # "pidfile" was never created
1932
 
            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
1933
2739
        del pidfilename
1934
 
        
1935
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1936
 
 
 
2740
    
1937
2741
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1938
2742
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1939
2743
    
1940
2744
    if use_dbus:
1941
 
        class MandosDBusService(dbus.service.Object):
 
2745
        
 
2746
        @alternate_dbus_interfaces(
 
2747
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
2748
        class MandosDBusService(DBusObjectWithProperties):
1942
2749
            """A D-Bus proxy object"""
 
2750
            
1943
2751
            def __init__(self):
1944
2752
                dbus.service.Object.__init__(self, bus, "/")
1945
 
            _interface = "se.bsnet.fukt.Mandos"
 
2753
            
 
2754
            _interface = "se.recompile.Mandos"
 
2755
            
 
2756
            @dbus_interface_annotations(_interface)
 
2757
            def _foo(self):
 
2758
                return {
 
2759
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2760
                    "false" }
1946
2761
            
1947
2762
            @dbus.service.signal(_interface, signature="o")
1948
2763
            def ClientAdded(self, objpath):
1962
2777
            @dbus.service.method(_interface, out_signature="ao")
1963
2778
            def GetAllClients(self):
1964
2779
                "D-Bus method"
1965
 
                return dbus.Array(c.dbus_object_path
1966
 
                                  for c in tcp_server.clients)
 
2780
                return dbus.Array(c.dbus_object_path for c in
 
2781
                                  tcp_server.clients.itervalues())
1967
2782
            
1968
2783
            @dbus.service.method(_interface,
1969
2784
                                 out_signature="a{oa{sv}}")
1970
2785
            def GetAllClientsWithProperties(self):
1971
2786
                "D-Bus method"
1972
2787
                return dbus.Dictionary(
1973
 
                    ((c.dbus_object_path, c.GetAll(""))
1974
 
                     for c in tcp_server.clients),
 
2788
                    { c.dbus_object_path: c.GetAll("")
 
2789
                      for c in tcp_server.clients.itervalues() },
1975
2790
                    signature="oa{sv}")
1976
2791
            
1977
2792
            @dbus.service.method(_interface, in_signature="o")
1978
2793
            def RemoveClient(self, object_path):
1979
2794
                "D-Bus method"
1980
 
                for c in tcp_server.clients:
 
2795
                for c in tcp_server.clients.itervalues():
1981
2796
                    if c.dbus_object_path == object_path:
1982
 
                        tcp_server.clients.remove(c)
 
2797
                        del tcp_server.clients[c.name]
1983
2798
                        c.remove_from_connection()
1984
2799
                        # Don't signal anything except ClientRemoved
1985
2800
                        c.disable(quiet=True)
1994
2809
    
1995
2810
    def cleanup():
1996
2811
        "Cleanup function; run on exit"
1997
 
        service.cleanup()
1998
 
        
 
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
1999
2873
        while tcp_server.clients:
2000
 
            client = tcp_server.clients.pop()
 
2874
            name, client = tcp_server.clients.popitem()
2001
2875
            if use_dbus:
2002
2876
                client.remove_from_connection()
2003
 
            client.disable_hook = None
2004
2877
            # Don't signal anything except ClientRemoved
2005
2878
            client.disable(quiet=True)
2006
2879
            if use_dbus:
2007
2880
                # Emit D-Bus signal
2008
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2009
 
                                                  client.name)
 
2881
                mandos_dbus_service.ClientRemoved(
 
2882
                    client.dbus_object_path, client.name)
 
2883
        client_settings.clear()
2010
2884
    
2011
2885
    atexit.register(cleanup)
2012
2886
    
2013
 
    for client in tcp_server.clients:
 
2887
    for client in tcp_server.clients.itervalues():
2014
2888
        if use_dbus:
2015
2889
            # Emit D-Bus signal
2016
2890
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2017
 
        client.enable()
 
2891
        # Need to initiate checking of clients
 
2892
        if client.enabled:
 
2893
            client.init_checker()
2018
2894
    
2019
2895
    tcp_server.enable()
2020
2896
    tcp_server.server_activate()
2021
2897
    
2022
2898
    # Find out what port we got
2023
 
    service.port = tcp_server.socket.getsockname()[1]
 
2899
    if zeroconf:
 
2900
        service.port = tcp_server.socket.getsockname()[1]
2024
2901
    if use_ipv6:
2025
2902
        logger.info("Now listening on address %r, port %d,"
2026
 
                    " flowinfo %d, scope_id %d"
2027
 
                    % tcp_server.socket.getsockname())
 
2903
                    " flowinfo %d, scope_id %d",
 
2904
                    *tcp_server.socket.getsockname())
2028
2905
    else:                       # IPv4
2029
 
        logger.info("Now listening on address %r, port %d"
2030
 
                    % tcp_server.socket.getsockname())
 
2906
        logger.info("Now listening on address %r, port %d",
 
2907
                    *tcp_server.socket.getsockname())
2031
2908
    
2032
2909
    #service.interface = tcp_server.socket.getsockname()[3]
2033
2910
    
2034
2911
    try:
2035
 
        # From the Avahi example code
2036
 
        try:
2037
 
            service.activate()
2038
 
        except dbus.exceptions.DBusException as error:
2039
 
            logger.critical("DBusException: %s", error)
2040
 
            cleanup()
2041
 
            sys.exit(1)
2042
 
        # 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
2043
2921
        
2044
2922
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2045
2923
                             lambda *args, **kwargs:
2049
2927
        logger.debug("Starting main loop")
2050
2928
        main_loop.run()
2051
2929
    except AvahiError as error:
2052
 
        logger.critical("AvahiError: %s", error)
 
2930
        logger.critical("Avahi Error", exc_info=error)
2053
2931
        cleanup()
2054
2932
        sys.exit(1)
2055
2933
    except KeyboardInterrupt:
2060
2938
    # Must run before the D-Bus bus name gets deregistered
2061
2939
    cleanup()
2062
2940
 
 
2941
 
2063
2942
if __name__ == '__main__':
2064
2943
    main()