/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2017-01-25 19:38:31 UTC
  • Revision ID: teddy@recompile.se-20170125193831-rz39tr8c5yg8yy7f
Tags: version-1.7.14-1
* Makefile (version): Change to 1.7.14.
* NEWS (Version 1.7.14): Add new entry.
* debian/changelog (1.7.14-1): - '' -

Show diffs side-by-side

added added

removed removed

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