/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2018-02-06 20:03:50 UTC
  • Revision ID: teddy@recompile.se-20180206200350-jzvorueb731xkph3
Update Debian Debhelper compatibility version.

* (debian/compat): Change to "10".

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