/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2018-02-08 10:23:55 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 362.
  • Revision ID: teddy@recompile.se-20180208102355-3ent7sf87i9h9kka
Update copyright year to 2018

* DBUS-API: Update copyright year to 2018.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* intro.xml: - '' -
* mandos: - '' -
* mandos-clients.conf.xml: - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml: - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml: - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* network-hooks.d/bridge: - '' -
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml: - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml: - '' -

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-2018 Teddy Hogeborn
 
15
# Copyright © 2008-2018 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
 
113
 
def initlogger(level=logging.WARNING):
 
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
 
 
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
 
    
121
 
    console = logging.StreamHandler()
122
 
    console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
123
 
                                           ' [%(process)d]:'
124
 
                                           ' %(levelname)s:'
125
 
                                           ' %(message)s'))
126
 
    logger.addHandler(console)
 
166
 
 
167
    if debug:
 
168
        console = logging.StreamHandler()
 
169
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
170
                                               ' [%(process)d]:'
 
171
                                               ' %(levelname)s:'
 
172
                                               ' %(message)s'))
 
173
        logger.addHandler(console)
127
174
    logger.setLevel(level)
128
175
 
129
176
 
134
181
 
135
182
class PGPEngine(object):
136
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
184
 
137
185
    def __init__(self):
138
 
        self.gnupg = GnuPGInterface.GnuPG()
139
186
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
140
 
        self.gnupg = GnuPGInterface.GnuPG()
141
 
        self.gnupg.options.meta_interactive = False
142
 
        self.gnupg.options.homedir = self.tempdir
143
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
144
 
                                              '--quiet'])
145
 
    
 
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
 
146
206
    def __enter__(self):
147
207
        return self
148
 
    
149
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
208
 
 
209
    def __exit__(self, exc_type, exc_value, traceback):
150
210
        self._cleanup()
151
211
        return False
152
 
    
 
212
 
153
213
    def __del__(self):
154
214
        self._cleanup()
155
 
    
 
215
 
156
216
    def _cleanup(self):
157
217
        if self.tempdir is not None:
158
218
            # Delete contents of tempdir
159
219
            for root, dirs, files in os.walk(self.tempdir,
160
 
                                             topdown = False):
 
220
                                             topdown=False):
161
221
                for filename in files:
162
222
                    os.remove(os.path.join(root, filename))
163
223
                for dirname in dirs:
165
225
            # Remove tempdir
166
226
            os.rmdir(self.tempdir)
167
227
            self.tempdir = None
168
 
    
 
228
 
169
229
    def password_encode(self, password):
170
230
        # Passphrase can not be empty and can not contain newlines or
171
231
        # NUL bytes.  So we prefix it and hex encode it.
172
 
        return b"mandos" + binascii.hexlify(password)
173
 
    
 
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
 
174
240
    def encrypt(self, data, password):
175
 
        self.gnupg.passphrase = self.password_encode(password)
176
 
        with open(os.devnull) as devnull:
177
 
            try:
178
 
                proc = self.gnupg.run(['--symmetric'],
179
 
                                      create_fhs=['stdin', 'stdout'],
180
 
                                      attach_fhs={'stderr': devnull})
181
 
                with contextlib.closing(proc.handles['stdin']) as f:
182
 
                    f.write(data)
183
 
                with contextlib.closing(proc.handles['stdout']) as f:
184
 
                    ciphertext = f.read()
185
 
                proc.wait()
186
 
            except IOError as e:
187
 
                raise PGPError(e)
188
 
        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)
189
256
        return ciphertext
190
 
    
 
257
 
191
258
    def decrypt(self, data, password):
192
 
        self.gnupg.passphrase = self.password_encode(password)
193
 
        with open(os.devnull) as devnull:
194
 
            try:
195
 
                proc = self.gnupg.run(['--decrypt'],
196
 
                                      create_fhs=['stdin', 'stdout'],
197
 
                                      attach_fhs={'stderr': devnull})
198
 
                with contextlib.closing(proc.handles['stdin'] ) as f:
199
 
                    f.write(data)
200
 
                with contextlib.closing(proc.handles['stdout']) as f:
201
 
                    decrypted_plaintext = f.read()
202
 
                proc.wait()
203
 
            except IOError as e:
204
 
                raise PGPError(e)
205
 
        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)
206
274
        return decrypted_plaintext
207
275
 
208
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
 
209
303
 
210
304
class AvahiError(Exception):
211
305
    def __init__(self, value, *args, **kwargs):
212
306
        self.value = value
213
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
214
 
    def __unicode__(self):
215
 
        return unicode(repr(self.value))
 
307
        return super(AvahiError, self).__init__(value, *args,
 
308
                                                **kwargs)
 
309
 
216
310
 
217
311
class AvahiServiceError(AvahiError):
218
312
    pass
219
313
 
 
314
 
220
315
class AvahiGroupError(AvahiError):
221
316
    pass
222
317
 
223
318
 
224
319
class AvahiService(object):
225
320
    """An Avahi (Zeroconf) service.
226
 
    
 
321
 
227
322
    Attributes:
228
323
    interface: integer; avahi.IF_UNSPEC or an interface index.
229
324
               Used to optionally bind to the specified interface.
230
325
    name: string; Example: 'Mandos'
231
326
    type: string; Example: '_mandos._tcp'.
232
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
327
     See <https://www.iana.org/assignments/service-names-port-numbers>
233
328
    port: integer; what port to announce
234
329
    TXT: list of strings; TXT record for the service
235
330
    domain: string; Domain to publish on, default to .local if empty.
241
336
    server: D-Bus Server
242
337
    bus: dbus.SystemBus()
243
338
    """
244
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
245
 
                 servicetype = None, port = None, TXT = None,
246
 
                 domain = "", host = "", max_renames = 32768,
247
 
                 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):
248
351
        self.interface = interface
249
352
        self.name = name
250
353
        self.type = servicetype
259
362
        self.server = None
260
363
        self.bus = bus
261
364
        self.entry_group_state_changed_match = None
262
 
    def rename(self):
 
365
 
 
366
    def rename(self, remove=True):
263
367
        """Derived from the Avahi example code"""
264
368
        if self.rename_count >= self.max_renames:
265
369
            logger.critical("No suitable Zeroconf service name found"
266
370
                            " after %i retries, exiting.",
267
371
                            self.rename_count)
268
372
            raise AvahiServiceError("Too many renames")
269
 
        self.name = unicode(self.server
270
 
                            .GetAlternativeServiceName(self.name))
 
373
        self.name = str(
 
374
            self.server.GetAlternativeServiceName(self.name))
 
375
        self.rename_count += 1
271
376
        logger.info("Changing Zeroconf service name to %r ...",
272
377
                    self.name)
273
 
        self.remove()
 
378
        if remove:
 
379
            self.remove()
274
380
        try:
275
381
            self.add()
276
382
        except dbus.exceptions.DBusException as error:
277
 
            logger.critical("DBusException: %s", error)
278
 
            self.cleanup()
279
 
            os._exit(1)
280
 
        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
 
281
392
    def remove(self):
282
393
        """Derived from the Avahi example code"""
283
394
        if self.entry_group_state_changed_match is not None:
285
396
            self.entry_group_state_changed_match = None
286
397
        if self.group is not None:
287
398
            self.group.Reset()
 
399
 
288
400
    def add(self):
289
401
        """Derived from the Avahi example code"""
290
402
        self.remove()
307
419
            dbus.UInt16(self.port),
308
420
            avahi.string_array_to_txt_array(self.TXT))
309
421
        self.group.Commit()
 
422
 
310
423
    def entry_group_state_changed(self, state, error):
311
424
        """Derived from the Avahi example code"""
312
425
        logger.debug("Avahi entry group state change: %i", state)
313
 
        
 
426
 
314
427
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
315
428
            logger.debug("Zeroconf service established.")
316
429
        elif state == avahi.ENTRY_GROUP_COLLISION:
318
431
            self.rename()
319
432
        elif state == avahi.ENTRY_GROUP_FAILURE:
320
433
            logger.critical("Avahi: Error in group state changed %s",
321
 
                            unicode(error))
322
 
            raise AvahiGroupError("State changed: %s"
323
 
                                  % unicode(error))
 
434
                            str(error))
 
435
            raise AvahiGroupError("State changed: {!s}".format(error))
 
436
 
324
437
    def cleanup(self):
325
438
        """Derived from the Avahi example code"""
326
439
        if self.group is not None:
331
444
                pass
332
445
            self.group = None
333
446
        self.remove()
 
447
 
334
448
    def server_state_changed(self, state, error=None):
335
449
        """Derived from the Avahi example code"""
336
450
        logger.debug("Avahi server state change: %i", state)
337
 
        bad_states = { avahi.SERVER_INVALID:
338
 
                           "Zeroconf server invalid",
339
 
                       avahi.SERVER_REGISTERING: None,
340
 
                       avahi.SERVER_COLLISION:
341
 
                           "Zeroconf server name collision",
342
 
                       avahi.SERVER_FAILURE:
343
 
                           "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
        }
344
457
        if state in bad_states:
345
458
            if bad_states[state] is not None:
346
459
                if error is None:
349
462
                    logger.error(bad_states[state] + ": %r", error)
350
463
            self.cleanup()
351
464
        elif state == avahi.SERVER_RUNNING:
352
 
            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)
353
477
        else:
354
478
            if error is None:
355
479
                logger.debug("Unknown state: %r", state)
356
480
            else:
357
481
                logger.debug("Unknown state: %r: %r", state, error)
 
482
 
358
483
    def activate(self):
359
484
        """Derived from the Avahi example code"""
360
485
        if self.server is None:
364
489
                                    follow_name_owner_changes=True),
365
490
                avahi.DBUS_INTERFACE_SERVER)
366
491
        self.server.connect_to_signal("StateChanged",
367
 
                                 self.server_state_changed)
 
492
                                      self.server_state_changed)
368
493
        self.server_state_changed(self.server.GetState())
369
494
 
 
495
 
370
496
class AvahiServiceToSyslog(AvahiService):
371
 
    def rename(self):
 
497
    def rename(self, *args, **kwargs):
372
498
        """Add the new name to the syslog messages"""
373
 
        ret = AvahiService.rename(self)
374
 
        syslogger.setFormatter(logging.Formatter
375
 
                               ('Mandos (%s) [%%(process)d]:'
376
 
                                ' %%(levelname)s: %%(message)s'
377
 
                                % 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)))
378
504
        return ret
379
505
 
380
 
def timedelta_to_milliseconds(td):
381
 
    "Convert a datetime.timedelta() to milliseconds"
382
 
    return ((td.days * 24 * 60 * 60 * 1000)
383
 
            + (td.seconds * 1000)
384
 
            + (td.microseconds // 1000))
385
 
        
 
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
 
386
781
class Client(object):
387
782
    """A representation of a client host served by this server.
388
 
    
 
783
 
389
784
    Attributes:
390
785
    approved:   bool(); 'None' if not yet approved/disapproved
391
786
    approval_delay: datetime.timedelta(); Time to wait for approval
393
788
    checker:    subprocess.Popen(); a running checker process used
394
789
                                    to see if the client lives.
395
790
                                    'None' if no process is running.
396
 
    checker_callback_tag: a gobject event source tag, or None
 
791
    checker_callback_tag: a GLib event source tag, or None
397
792
    checker_command: string; External command which is run to check
398
793
                     if client lives.  %() expansions are done at
399
794
                     runtime with vars(self) as dict, so that for
400
795
                     instance %(name)s can be used in the command.
401
 
    checker_initiator_tag: a gobject event source tag, or None
 
796
    checker_initiator_tag: a GLib event source tag, or None
402
797
    created:    datetime.datetime(); (UTC) object creation
403
798
    client_structure: Object describing what attributes a client has
404
799
                      and is used for storing the client at exit
405
800
    current_checker_command: string; current running checker_command
406
 
    disable_initiator_tag: a gobject event source tag, or None
 
801
    disable_initiator_tag: a GLib event source tag, or None
407
802
    enabled:    bool()
408
803
    fingerprint: string (40 or 32 hexadecimal digits); used to
409
804
                 uniquely identify the client
413
808
    last_checked_ok: datetime.datetime(); (UTC) or None
414
809
    last_checker_status: integer between 0 and 255 reflecting exit
415
810
                         status of last checker. -1 reflects crashed
416
 
                         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
417
814
    last_enabled: datetime.datetime(); (UTC) or None
418
815
    name:       string; from the config file, used in log messages and
419
816
                        D-Bus identifiers
420
817
    secret:     bytestring; sent verbatim (over TLS) to client
421
818
    timeout:    datetime.timedelta(); How long from last_checked_ok
422
819
                                      until this client is disabled
423
 
    extended_timeout:   extra long timeout when password has been sent
 
820
    extended_timeout:   extra long timeout when secret has been sent
424
821
    runtime_expansions: Allowed attributes for runtime expansion.
425
822
    expires:    datetime.datetime(); time (UTC) when a client will be
426
823
                disabled, or None
 
824
    server_settings: The server_settings dict from main()
427
825
    """
428
 
    
 
826
 
429
827
    runtime_expansions = ("approval_delay", "approval_duration",
430
 
                          "created", "enabled", "fingerprint",
431
 
                          "host", "interval", "last_checked_ok",
 
828
                          "created", "enabled", "expires",
 
829
                          "fingerprint", "host", "interval",
 
830
                          "last_approval_request", "last_checked_ok",
432
831
                          "last_enabled", "name", "timeout")
433
 
    client_defaults = { "timeout": "5m",
434
 
                        "extended_timeout": "15m",
435
 
                        "interval": "2m",
436
 
                        "checker": "fping -q -- %%(host)s",
437
 
                        "host": "",
438
 
                        "approval_delay": "0s",
439
 
                        "approval_duration": "1s",
440
 
                        "approved_by_default": "True",
441
 
                        "enabled": "True",
442
 
                        }
443
 
    
444
 
    def timeout_milliseconds(self):
445
 
        "Return the 'timeout' attribute in milliseconds"
446
 
        return timedelta_to_milliseconds(self.timeout)
447
 
    
448
 
    def extended_timeout_milliseconds(self):
449
 
        "Return the 'extended_timeout' attribute in milliseconds"
450
 
        return timedelta_to_milliseconds(self.extended_timeout)
451
 
    
452
 
    def interval_milliseconds(self):
453
 
        "Return the 'interval' attribute in milliseconds"
454
 
        return timedelta_to_milliseconds(self.interval)
455
 
    
456
 
    def approval_delay_milliseconds(self):
457
 
        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
    }
458
843
 
459
844
    @staticmethod
460
845
    def config_parser(config):
461
 
        """ Construct a new dict of client settings of this form:
 
846
        """Construct a new dict of client settings of this form:
462
847
        { client_name: {setting_name: value, ...}, ...}
463
 
        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
        """
464
852
        settings = {}
465
853
        for client_name in config.sections():
466
854
            section = dict(config.items(client_name))
467
855
            client = settings[client_name] = {}
468
 
            
 
856
 
469
857
            client["host"] = section["host"]
470
858
            # Reformat values from string types to Python types
471
859
            client["approved_by_default"] = config.getboolean(
472
860
                client_name, "approved_by_default")
473
 
            client["enabled"] = config.getboolean(client_name, "enabled")
474
 
            
 
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
475
867
            client["fingerprint"] = (section["fingerprint"].upper()
476
868
                                     .replace(" ", ""))
477
869
            if "secret" in section:
478
 
                client["secret"] = section["secret"].decode("base64")
 
870
                client["secret"] = codecs.decode(section["secret"]
 
871
                                                 .encode("utf-8"),
 
872
                                                 "base64")
479
873
            elif "secfile" in section:
480
874
                with open(os.path.expanduser(os.path.expandvars
481
875
                                             (section["secfile"])),
482
876
                          "rb") as secfile:
483
877
                    client["secret"] = secfile.read()
484
878
            else:
485
 
                raise TypeError("No secret or secfile for section %s"
486
 
                                % section)
 
879
                raise TypeError("No secret or secfile for section {}"
 
880
                                .format(section))
487
881
            client["timeout"] = string_to_delta(section["timeout"])
488
882
            client["extended_timeout"] = string_to_delta(
489
883
                section["extended_timeout"])
495
889
            client["checker_command"] = section["checker"]
496
890
            client["last_approval_request"] = None
497
891
            client["last_checked_ok"] = None
498
 
            client["last_checker_status"] = None
499
 
            if client["enabled"]:
500
 
                client["last_enabled"] = datetime.datetime.utcnow()
501
 
                client["expires"] = (datetime.datetime.utcnow()
502
 
                                     + client["timeout"])
503
 
            else:
504
 
                client["last_enabled"] = None
505
 
                client["expires"] = None
 
892
            client["last_checker_status"] = -2
506
893
 
507
894
        return settings
508
 
        
509
 
        
510
 
    def __init__(self, settings, name = None):
511
 
        """Note: the 'checker' key in 'config' sets the
512
 
        'checker_command' attribute and *not* the 'checker'
513
 
        attribute."""
 
895
 
 
896
    def __init__(self, settings, name=None, server_settings=None):
514
897
        self.name = name
 
898
        if server_settings is None:
 
899
            server_settings = {}
 
900
        self.server_settings = server_settings
515
901
        # adding all client settings
516
 
        for setting, value in settings.iteritems():
 
902
        for setting, value in settings.items():
517
903
            setattr(self, setting, value)
518
 
        
 
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
 
519
915
        logger.debug("Creating client %r", self.name)
520
 
        # Uppercase and remove spaces from fingerprint for later
521
 
        # comparison purposes with return value from the fingerprint()
522
 
        # function
523
916
        logger.debug("  Fingerprint: %s", self.fingerprint)
524
 
        self.created = settings.get("created", datetime.datetime.utcnow())
 
917
        self.created = settings.get("created",
 
918
                                    datetime.datetime.utcnow())
525
919
 
526
920
        # attributes specific for this server instance
527
921
        self.checker = None
531
925
        self.current_checker_command = None
532
926
        self.approved = None
533
927
        self.approvals_pending = 0
534
 
        self.changedstate = (multiprocessing_manager
535
 
                             .Condition(multiprocessing_manager
536
 
                                        .Lock()))
537
 
        self.client_structure = [attr for attr in
538
 
                                 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()
539
932
                                 if not attr.startswith("_")]
540
933
        self.client_structure.append("client_structure")
541
 
        
542
 
        for name, t in inspect.getmembers(type(self),
543
 
                                          lambda obj:
544
 
                                              isinstance(obj,
545
 
                                                         property)):
 
934
 
 
935
        for name, t in inspect.getmembers(
 
936
                type(self), lambda obj: isinstance(obj, property)):
546
937
            if not name.startswith("_"):
547
938
                self.client_structure.append(name)
548
 
    
 
939
 
549
940
    # Send notice to process children that client state has changed
550
941
    def send_changedstate(self):
551
942
        with self.changedstate:
552
943
            self.changedstate.notify_all()
553
 
    
 
944
 
554
945
    def enable(self):
555
946
        """Start this client's checker and timeout hooks"""
556
947
        if getattr(self, "enabled", False):
557
948
            # Already enabled
558
949
            return
559
 
        self.send_changedstate()
560
950
        self.expires = datetime.datetime.utcnow() + self.timeout
561
951
        self.enabled = True
562
952
        self.last_enabled = datetime.datetime.utcnow()
563
953
        self.init_checker()
564
 
    
 
954
        self.send_changedstate()
 
955
 
565
956
    def disable(self, quiet=True):
566
957
        """Disable this client."""
567
958
        if not getattr(self, "enabled", False):
568
959
            return False
569
960
        if not quiet:
570
 
            self.send_changedstate()
571
 
        if not quiet:
572
961
            logger.info("Disabling client %s", self.name)
573
 
        if getattr(self, "disable_initiator_tag", False):
574
 
            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)
575
964
            self.disable_initiator_tag = None
576
965
        self.expires = None
577
 
        if getattr(self, "checker_initiator_tag", False):
578
 
            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)
579
968
            self.checker_initiator_tag = None
580
969
        self.stop_checker()
581
970
        self.enabled = False
582
 
        # 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
583
974
        return False
584
 
    
 
975
 
585
976
    def __del__(self):
586
977
        self.disable()
587
 
    
 
978
 
588
979
    def init_checker(self):
589
980
        # Schedule a new checker to be started an 'interval' from now,
590
981
        # and every interval from then on.
591
 
        self.checker_initiator_tag = (gobject.timeout_add
592
 
                                      (self.interval_milliseconds(),
593
 
                                       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)
594
987
        # Schedule a disable() when 'timeout' has passed
595
 
        self.disable_initiator_tag = (gobject.timeout_add
596
 
                                   (self.timeout_milliseconds(),
597
 
                                    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)
598
992
        # Also start a new checker *right now*.
599
993
        self.start_checker()
600
 
    
601
 
    def checker_callback(self, pid, condition, command):
 
994
 
 
995
    def checker_callback(self, source, condition, connection,
 
996
                         command):
602
997
        """The checker has completed, so take appropriate actions."""
603
998
        self.checker_callback_tag = None
604
999
        self.checker = None
605
 
        if os.WIFEXITED(condition):
606
 
            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
607
1007
            if self.last_checker_status == 0:
608
1008
                logger.info("Checker for %(name)s succeeded",
609
1009
                            vars(self))
610
1010
                self.checked_ok()
611
1011
            else:
612
 
                logger.info("Checker for %(name)s failed",
613
 
                            vars(self))
 
1012
                logger.info("Checker for %(name)s failed", vars(self))
614
1013
        else:
615
1014
            self.last_checker_status = -1
 
1015
            self.last_checker_signal = -returncode
616
1016
            logger.warning("Checker for %(name)s crashed?",
617
1017
                           vars(self))
618
 
    
619
 
    def checked_ok(self, timeout=None):
620
 
        """Bump up the timeout for this client.
621
 
        
622
 
        This should only be called when the client has been seen,
623
 
        alive and well.
624
 
        """
 
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."""
625
1029
        if timeout is None:
626
1030
            timeout = self.timeout
627
 
        self.last_checked_ok = datetime.datetime.utcnow()
628
1031
        if self.disable_initiator_tag is not None:
629
 
            gobject.source_remove(self.disable_initiator_tag)
 
1032
            GLib.source_remove(self.disable_initiator_tag)
 
1033
            self.disable_initiator_tag = None
630
1034
        if getattr(self, "enabled", False):
631
 
            self.disable_initiator_tag = (gobject.timeout_add
632
 
                                          (timedelta_to_milliseconds
633
 
                                           (timeout), self.disable))
 
1035
            self.disable_initiator_tag = GLib.timeout_add(
 
1036
                int(timeout.total_seconds() * 1000), self.disable)
634
1037
            self.expires = datetime.datetime.utcnow() + timeout
635
 
    
 
1038
 
636
1039
    def need_approval(self):
637
1040
        self.last_approval_request = datetime.datetime.utcnow()
638
 
    
 
1041
 
639
1042
    def start_checker(self):
640
1043
        """Start a new checker subprocess if one is not running.
641
 
        
 
1044
 
642
1045
        If a checker already exists, leave it running and do
643
1046
        nothing."""
644
1047
        # The reason for not killing a running checker is that if we
645
 
        # did that, then if a checker (for some reason) started
646
 
        # running slowly and taking more than 'interval' time, the
647
 
        # client would inevitably timeout, since no checker would get
648
 
        # 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
649
1052
        # checkers alone, the checker would have to take more time
650
1053
        # than 'timeout' for the client to be disabled, which is as it
651
1054
        # should be.
652
 
        
653
 
        # If a checker exists, make sure it is not a zombie
654
 
        try:
655
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
656
 
        except (AttributeError, OSError) as error:
657
 
            if (isinstance(error, OSError)
658
 
                and error.errno != errno.ECHILD):
659
 
                raise error
660
 
        else:
661
 
            if pid:
662
 
                logger.warning("Checker was a zombie")
663
 
                gobject.source_remove(self.checker_callback_tag)
664
 
                self.checker_callback(pid, status,
665
 
                                      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
666
1060
        # Start a new checker if needed
667
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}
668
1066
            try:
669
 
                # In case checker_command has exactly one % operator
670
 
                command = self.checker_command % self.host
671
 
            except TypeError:
672
 
                # Escape attributes for the shell
673
 
                escaped_attrs = dict(
674
 
                    (attr,
675
 
                     re.escape(unicode(str(getattr(self, attr, "")),
676
 
                                       errors=
677
 
                                       'replace')))
678
 
                    for attr in
679
 
                    self.runtime_expansions)
680
 
                
681
 
                try:
682
 
                    command = self.checker_command % escaped_attrs
683
 
                except TypeError as error:
684
 
                    logger.error('Could not format string "%s":'
685
 
                                 ' %s', self.checker_command, error)
686
 
                    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
687
1073
            self.current_checker_command = command
688
 
            try:
689
 
                logger.info("Starting checker %r for %s",
690
 
                            command, self.name)
691
 
                # We don't need to redirect stdout and stderr, since
692
 
                # in normal mode, that is already done by daemon(),
693
 
                # and in debug mode we don't want to.  (Stdin is
694
 
                # always replaced by /dev/null.)
695
 
                self.checker = subprocess.Popen(command,
696
 
                                                close_fds=True,
697
 
                                                shell=True, cwd="/")
698
 
                self.checker_callback_tag = (gobject.child_watch_add
699
 
                                             (self.checker.pid,
700
 
                                              self.checker_callback,
701
 
                                              data=command))
702
 
                # The checker may have completed before the gobject
703
 
                # watch was added.  Check for this.
704
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
705
 
                if pid:
706
 
                    gobject.source_remove(self.checker_callback_tag)
707
 
                    self.checker_callback(pid, status, command)
708
 
            except OSError as error:
709
 
                logger.error("Failed to start subprocess: %s",
710
 
                             error)
711
 
        # 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
712
1100
        return True
713
 
    
 
1101
 
714
1102
    def stop_checker(self):
715
1103
        """Force the checker process, if any, to stop."""
716
1104
        if self.checker_callback_tag:
717
 
            gobject.source_remove(self.checker_callback_tag)
 
1105
            GLib.source_remove(self.checker_callback_tag)
718
1106
            self.checker_callback_tag = None
719
1107
        if getattr(self, "checker", None) is None:
720
1108
            return
721
1109
        logger.debug("Stopping checker for %(name)s", vars(self))
722
 
        try:
723
 
            os.kill(self.checker.pid, signal.SIGTERM)
724
 
            #time.sleep(0.5)
725
 
            #if self.checker.poll() is None:
726
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
727
 
        except OSError as error:
728
 
            if error.errno != errno.ESRCH: # No such process
729
 
                raise
 
1110
        self.checker.terminate()
730
1111
        self.checker = None
731
1112
 
732
1113
 
733
 
def dbus_service_property(dbus_interface, signature="v",
734
 
                          access="readwrite", byte_arrays=False):
 
1114
def dbus_service_property(dbus_interface,
 
1115
                          signature="v",
 
1116
                          access="readwrite",
 
1117
                          byte_arrays=False):
735
1118
    """Decorators for marking methods of a DBusObjectWithProperties to
736
1119
    become properties on the D-Bus.
737
 
    
 
1120
 
738
1121
    The decorated method will be called with no arguments by "Get"
739
1122
    and with one argument by "Set".
740
 
    
 
1123
 
741
1124
    The parameters, where they are supported, are the same as
742
1125
    dbus.service.method, except there is only "signature", since the
743
1126
    type from Get() and the type sent to Set() is the same.
746
1129
    # "Set" method, so we fail early here:
747
1130
    if byte_arrays and signature != "ay":
748
1131
        raise ValueError("Byte arrays not supported for non-'ay'"
749
 
                         " signature %r" % signature)
 
1132
                         " signature {!r}".format(signature))
 
1133
 
750
1134
    def decorator(func):
751
1135
        func._dbus_is_property = True
752
1136
        func._dbus_interface = dbus_interface
755
1139
        func._dbus_name = func.__name__
756
1140
        if func._dbus_name.endswith("_dbus_property"):
757
1141
            func._dbus_name = func._dbus_name[:-14]
758
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
759
 
        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
 
760
1188
    return decorator
761
1189
 
762
1190
 
763
1191
class DBusPropertyException(dbus.exceptions.DBusException):
764
1192
    """A base class for D-Bus property-related exceptions
765
1193
    """
766
 
    def __unicode__(self):
767
 
        return unicode(str(self))
 
1194
    pass
768
1195
 
769
1196
 
770
1197
class DBusPropertyAccessException(DBusPropertyException):
779
1206
    pass
780
1207
 
781
1208
 
782
 
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):
783
1299
    """A D-Bus object with properties.
784
 
    
 
1300
 
785
1301
    Classes inheriting from this can use the dbus_service_property
786
1302
    decorator to expose methods as D-Bus properties.  It exposes the
787
1303
    standard Get(), Set(), and GetAll() methods on the D-Bus.
788
1304
    """
789
 
    
790
 
    @staticmethod
791
 
    def _is_dbus_property(obj):
792
 
        return getattr(obj, "_dbus_is_property", False)
793
 
    
794
 
    def _get_all_dbus_properties(self):
795
 
        """Returns a generator of (name, attribute) pairs
796
 
        """
797
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
798
 
                for cls in self.__class__.__mro__
799
 
                for name, prop in
800
 
                inspect.getmembers(cls, self._is_dbus_property))
801
 
    
 
1305
 
802
1306
    def _get_dbus_property(self, interface_name, property_name):
803
1307
        """Returns a bound method if one exists which is a D-Bus
804
1308
        property with the specified name and interface.
805
1309
        """
806
 
        for cls in  self.__class__.__mro__:
807
 
            for name, value in (inspect.getmembers
808
 
                                (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")):
809
1313
                if (value._dbus_name == property_name
810
1314
                    and value._dbus_interface == interface_name):
811
1315
                    return value.__get__(self)
812
 
        
 
1316
 
813
1317
        # No such property
814
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
815
 
                                   + interface_name + "."
816
 
                                   + property_name)
817
 
    
818
 
    @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",
819
1332
                         out_signature="v")
820
1333
    def Get(self, interface_name, property_name):
821
1334
        """Standard D-Bus property Get() method, see D-Bus standard.
827
1340
        if not hasattr(value, "variant_level"):
828
1341
            return value
829
1342
        return type(value)(value, variant_level=value.variant_level+1)
830
 
    
 
1343
 
831
1344
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
832
1345
    def Set(self, interface_name, property_name, value):
833
1346
        """Standard D-Bus property Set() method, see D-Bus standard.
839
1352
            # The byte_arrays option is not supported yet on
840
1353
            # signatures other than "ay".
841
1354
            if prop._dbus_signature != "ay":
842
 
                raise ValueError
843
 
            value = dbus.ByteArray(''.join(unichr(byte)
844
 
                                           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))
845
1360
        prop(value)
846
 
    
847
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1361
 
 
1362
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1363
                         in_signature="s",
848
1364
                         out_signature="a{sv}")
849
1365
    def GetAll(self, interface_name):
850
1366
        """Standard D-Bus property GetAll() method, see D-Bus
851
1367
        standard.
852
 
        
 
1368
 
853
1369
        Note: Will not include properties with access="write".
854
1370
        """
855
1371
        properties = {}
856
 
        for name, prop in self._get_all_dbus_properties():
 
1372
        for name, prop in self._get_all_dbus_things("property"):
857
1373
            if (interface_name
858
1374
                and interface_name != prop._dbus_interface):
859
1375
                # Interface non-empty but did not match
865
1381
            if not hasattr(value, "variant_level"):
866
1382
                properties[name] = value
867
1383
                continue
868
 
            properties[name] = type(value)(value, variant_level=
869
 
                                           value.variant_level+1)
 
1384
            properties[name] = type(value)(
 
1385
                value, variant_level=value.variant_level + 1)
870
1386
        return dbus.Dictionary(properties, signature="sv")
871
 
    
 
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
 
872
1396
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
873
1397
                         out_signature="s",
874
1398
                         path_keyword='object_path',
875
1399
                         connection_keyword='connection')
876
1400
    def Introspect(self, object_path, connection):
877
 
        """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.
878
1404
        """
879
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
880
 
                                                   connection)
 
1405
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1406
                                                         object_path,
 
1407
                                                         connection)
881
1408
        try:
882
1409
            document = xml.dom.minidom.parseString(xmlstring)
 
1410
 
883
1411
            def make_tag(document, name, prop):
884
1412
                e = document.createElement("property")
885
1413
                e.setAttribute("name", name)
886
1414
                e.setAttribute("type", prop._dbus_signature)
887
1415
                e.setAttribute("access", prop._dbus_access)
888
1416
                return e
 
1417
 
889
1418
            for if_tag in document.getElementsByTagName("interface"):
 
1419
                # Add property tags
890
1420
                for tag in (make_tag(document, name, prop)
891
1421
                            for name, prop
892
 
                            in self._get_all_dbus_properties()
 
1422
                            in self._get_all_dbus_things("property")
893
1423
                            if prop._dbus_interface
894
1424
                            == if_tag.getAttribute("name")):
895
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)
896
1442
                # Add the names to the return values for the
897
1443
                # "org.freedesktop.DBus.Properties" methods
898
1444
                if (if_tag.getAttribute("name")
913
1459
        except (AttributeError, xml.dom.DOMException,
914
1460
                xml.parsers.expat.ExpatError) as error:
915
1461
            logger.error("Failed to override Introspection method",
916
 
                         error)
917
 
        return xmlstring
918
 
 
919
 
 
920
 
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):
921
1538
    """Convert a UTC datetime.datetime() to a D-Bus type."""
922
1539
    if dt is None:
923
 
        return dbus.String("", variant_level = variant_level)
924
 
    return dbus.String(dt.isoformat(),
925
 
                       variant_level=variant_level)
926
 
 
927
 
 
928
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
929
 
                                  .__metaclass__):
930
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
931
 
    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).
932
1566
    """
933
 
    def __new__(mcs, name, bases, attr):
934
 
        # Go through all the base classes which could have D-Bus
935
 
        # methods, signals, or properties in them
936
 
        for base in (b for b in bases
937
 
                     if issubclass(b, dbus.service.Object)):
938
 
            # Go though all attributes of the base class
939
 
            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):
940
1575
                # Ignore non-D-Bus attributes, and D-Bus attributes
941
1576
                # with the wrong interface name
942
1577
                if (not hasattr(attribute, "_dbus_interface")
943
 
                    or not attribute._dbus_interface
944
 
                    .startswith("se.recompile.Mandos")):
 
1578
                    or not attribute._dbus_interface.startswith(
 
1579
                        orig_interface_name)):
945
1580
                    continue
946
1581
                # Create an alternate D-Bus interface name based on
947
1582
                # the current name
948
 
                alt_interface = (attribute._dbus_interface
949
 
                                 .replace("se.recompile.Mandos",
950
 
                                          "se.bsnet.fukt.Mandos"))
 
1583
                alt_interface = attribute._dbus_interface.replace(
 
1584
                    orig_interface_name, alt_interface_name)
 
1585
                interface_names.add(alt_interface)
951
1586
                # Is this a D-Bus signal?
952
1587
                if getattr(attribute, "_dbus_is_signal", False):
953
 
                    # Extract the original non-method function by
954
 
                    # black magic
955
 
                    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(
956
1592
                            zip(attribute.func_code.co_freevars,
957
 
                                attribute.__closure__))["func"]
958
 
                                      .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)
959
1600
                    # Create a new, but exactly alike, function
960
1601
                    # object, and decorate it to be a new D-Bus signal
961
1602
                    # with the alternate D-Bus interface name
962
 
                    new_function = (dbus.service.signal
963
 
                                    (alt_interface,
964
 
                                     attribute._dbus_signature)
965
 
                                    (types.FunctionType(
966
 
                                nonmethod_func.func_code,
967
 
                                nonmethod_func.func_globals,
968
 
                                nonmethod_func.func_name,
969
 
                                nonmethod_func.func_defaults,
970
 
                                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
 
971
1614
                    # Define a creator of a function to call both the
972
 
                    # old and new functions, so both the old and new
973
 
                    # 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
974
1618
                    def fixscope(func1, func2):
975
1619
                        """This function is a scope container to pass
976
1620
                        func1 and func2 to the "call_both" function
977
1621
                        outside of its arguments"""
 
1622
 
 
1623
                        @functools.wraps(func2)
978
1624
                        def call_both(*args, **kwargs):
979
1625
                            """This function will emit two D-Bus
980
1626
                            signals by calling func1 and func2"""
981
1627
                            func1(*args, **kwargs)
982
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
 
983
1635
                        return call_both
984
1636
                    # Create the "call_both" function and add it to
985
1637
                    # the class
986
 
                    attr[attrname] = fixscope(attribute,
987
 
                                              new_function)
 
1638
                    attr[attrname] = fixscope(attribute, new_function)
988
1639
                # Is this a D-Bus method?
989
1640
                elif getattr(attribute, "_dbus_is_method", False):
990
1641
                    # Create a new, but exactly alike, function
991
1642
                    # object.  Decorate it to be a new D-Bus method
992
1643
                    # with the alternate D-Bus interface name.  Add it
993
1644
                    # to the class.
994
 
                    attr[attrname] = (dbus.service.method
995
 
                                      (alt_interface,
996
 
                                       attribute._dbus_in_signature,
997
 
                                       attribute._dbus_out_signature)
998
 
                                      (types.FunctionType
999
 
                                       (attribute.func_code,
1000
 
                                        attribute.func_globals,
1001
 
                                        attribute.func_name,
1002
 
                                        attribute.func_defaults,
1003
 
                                        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
1004
1657
                # Is this a D-Bus property?
1005
1658
                elif getattr(attribute, "_dbus_is_property", False):
1006
1659
                    # Create a new, but exactly alike, function
1007
1660
                    # object, and decorate it to be a new D-Bus
1008
1661
                    # property with the alternate D-Bus interface
1009
1662
                    # name.  Add it to the class.
1010
 
                    attr[attrname] = (dbus_service_property
1011
 
                                      (alt_interface,
1012
 
                                       attribute._dbus_signature,
1013
 
                                       attribute._dbus_access,
1014
 
                                       attribute
1015
 
                                       ._dbus_get_args_options
1016
 
                                       ["byte_arrays"])
1017
 
                                      (types.FunctionType
1018
 
                                       (attribute.func_code,
1019
 
                                        attribute.func_globals,
1020
 
                                        attribute.func_name,
1021
 
                                        attribute.func_defaults,
1022
 
                                        attribute.func_closure)))
1023
 
        return type.__new__(mcs, name, bases, attr)
1024
 
 
1025
 
 
 
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"})
1026
1715
class ClientDBus(Client, DBusObjectWithProperties):
1027
1716
    """A Client class using D-Bus
1028
 
    
 
1717
 
1029
1718
    Attributes:
1030
1719
    dbus_object_path: dbus.ObjectPath
1031
1720
    bus: dbus.SystemBus()
1032
1721
    """
1033
 
    
 
1722
 
1034
1723
    runtime_expansions = (Client.runtime_expansions
1035
 
                          + ("dbus_object_path",))
1036
 
    
 
1724
                          + ("dbus_object_path", ))
 
1725
 
 
1726
    _interface = "se.recompile.Mandos.Client"
 
1727
 
1037
1728
    # dbus.service.Object doesn't use super(), so we can't either.
1038
 
    
1039
 
    def __init__(self, bus = None, *args, **kwargs):
 
1729
 
 
1730
    def __init__(self, bus=None, *args, **kwargs):
1040
1731
        self.bus = bus
1041
1732
        Client.__init__(self, *args, **kwargs)
1042
 
        self._approvals_pending = 0
1043
 
        
1044
 
        self._approvals_pending = 0
1045
1733
        # Only now, when this client is initialized, can it show up on
1046
1734
        # the D-Bus
1047
 
        client_object_name = unicode(self.name).translate(
 
1735
        client_object_name = str(self.name).translate(
1048
1736
            {ord("."): ord("_"),
1049
1737
             ord("-"): ord("_")})
1050
 
        self.dbus_object_path = (dbus.ObjectPath
1051
 
                                 ("/clients/" + client_object_name))
 
1738
        self.dbus_object_path = dbus.ObjectPath(
 
1739
            "/clients/" + client_object_name)
1052
1740
        DBusObjectWithProperties.__init__(self, self.bus,
1053
1741
                                          self.dbus_object_path)
1054
 
        
1055
 
    def notifychangeproperty(transform_func,
1056
 
                             dbus_name, type_func=lambda x: x,
1057
 
                             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):
1058
1748
        """ Modify a variable so that it's a property which announces
1059
1749
        its changes to DBus.
1060
 
        
 
1750
 
1061
1751
        transform_fun: Function that takes a value and a variant_level
1062
1752
                       and transforms it to a D-Bus type.
1063
1753
        dbus_name: D-Bus name of the variable
1065
1755
                   to the D-Bus.  Default: no transform
1066
1756
        variant_level: D-Bus variant level.  Default: 1
1067
1757
        """
1068
 
        attrname = "_{0}".format(dbus_name)
 
1758
        attrname = "_{}".format(dbus_name)
 
1759
 
1069
1760
        def setter(self, value):
1070
1761
            if hasattr(self, "dbus_object_path"):
1071
1762
                if (not hasattr(self, attrname) or
1072
1763
                    type_func(getattr(self, attrname, None))
1073
1764
                    != type_func(value)):
1074
 
                    dbus_value = transform_func(type_func(value),
1075
 
                                                variant_level
1076
 
                                                =variant_level)
1077
 
                    self.PropertyChanged(dbus.String(dbus_name),
1078
 
                                         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())
1079
1780
            setattr(self, attrname, value)
1080
 
        
 
1781
 
1081
1782
        return property(lambda self: getattr(self, attrname), setter)
1082
 
    
1083
 
    
 
1783
 
1084
1784
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1085
1785
    approvals_pending = notifychangeproperty(dbus.Boolean,
1086
1786
                                             "ApprovalPending",
1087
 
                                             type_func = bool)
 
1787
                                             type_func=bool)
1088
1788
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1089
1789
    last_enabled = notifychangeproperty(datetime_to_dbus,
1090
1790
                                        "LastEnabled")
1091
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1092
 
                                   type_func = lambda checker:
1093
 
                                       checker is not None)
 
1791
    checker = notifychangeproperty(
 
1792
        dbus.Boolean, "CheckerRunning",
 
1793
        type_func=lambda checker: checker is not None)
1094
1794
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1095
1795
                                           "LastCheckedOK")
 
1796
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1797
                                               "LastCheckerStatus")
1096
1798
    last_approval_request = notifychangeproperty(
1097
1799
        datetime_to_dbus, "LastApprovalRequest")
1098
1800
    approved_by_default = notifychangeproperty(dbus.Boolean,
1099
1801
                                               "ApprovedByDefault")
1100
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1101
 
                                          "ApprovalDelay",
1102
 
                                          type_func =
1103
 
                                          timedelta_to_milliseconds)
 
1802
    approval_delay = notifychangeproperty(
 
1803
        dbus.UInt64, "ApprovalDelay",
 
1804
        type_func=lambda td: td.total_seconds() * 1000)
1104
1805
    approval_duration = notifychangeproperty(
1105
1806
        dbus.UInt64, "ApprovalDuration",
1106
 
        type_func = timedelta_to_milliseconds)
 
1807
        type_func=lambda td: td.total_seconds() * 1000)
1107
1808
    host = notifychangeproperty(dbus.String, "Host")
1108
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1109
 
                                   type_func =
1110
 
                                   timedelta_to_milliseconds)
 
1809
    timeout = notifychangeproperty(
 
1810
        dbus.UInt64, "Timeout",
 
1811
        type_func=lambda td: td.total_seconds() * 1000)
1111
1812
    extended_timeout = notifychangeproperty(
1112
1813
        dbus.UInt64, "ExtendedTimeout",
1113
 
        type_func = timedelta_to_milliseconds)
1114
 
    interval = notifychangeproperty(dbus.UInt64,
1115
 
                                    "Interval",
1116
 
                                    type_func =
1117
 
                                    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)
1118
1818
    checker_command = notifychangeproperty(dbus.String, "Checker")
1119
 
    
 
1819
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1820
                                  invalidate_only=True)
 
1821
 
1120
1822
    del notifychangeproperty
1121
 
    
 
1823
 
1122
1824
    def __del__(self, *args, **kwargs):
1123
1825
        try:
1124
1826
            self.remove_from_connection()
1127
1829
        if hasattr(DBusObjectWithProperties, "__del__"):
1128
1830
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1129
1831
        Client.__del__(self, *args, **kwargs)
1130
 
    
1131
 
    def checker_callback(self, pid, condition, command,
1132
 
                         *args, **kwargs):
1133
 
        self.checker_callback_tag = None
1134
 
        self.checker = None
1135
 
        if os.WIFEXITED(condition):
1136
 
            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:
1137
1840
            # Emit D-Bus signal
1138
1841
            self.CheckerCompleted(dbus.Int16(exitstatus),
1139
 
                                  dbus.Int64(condition),
 
1842
                                  # This is specific to GNU libC
 
1843
                                  dbus.Int64(exitstatus << 8),
1140
1844
                                  dbus.String(command))
1141
1845
        else:
1142
1846
            # Emit D-Bus signal
1143
1847
            self.CheckerCompleted(dbus.Int16(-1),
1144
 
                                  dbus.Int64(condition),
 
1848
                                  dbus.Int64(
 
1849
                                      # This is specific to GNU libC
 
1850
                                      (exitstatus << 8)
 
1851
                                      | self.last_checker_signal),
1145
1852
                                  dbus.String(command))
1146
 
        
1147
 
        return Client.checker_callback(self, pid, condition, command,
1148
 
                                       *args, **kwargs)
1149
 
    
 
1853
        return ret
 
1854
 
1150
1855
    def start_checker(self, *args, **kwargs):
1151
 
        old_checker = self.checker
1152
 
        if self.checker is not None:
1153
 
            old_checker_pid = self.checker.pid
1154
 
        else:
1155
 
            old_checker_pid = None
 
1856
        old_checker_pid = getattr(self.checker, "pid", None)
1156
1857
        r = Client.start_checker(self, *args, **kwargs)
1157
1858
        # Only if new checker process was started
1158
1859
        if (self.checker is not None
1160
1861
            # Emit D-Bus signal
1161
1862
            self.CheckerStarted(self.current_checker_command)
1162
1863
        return r
1163
 
    
 
1864
 
1164
1865
    def _reset_approved(self):
1165
1866
        self.approved = None
1166
1867
        return False
1167
 
    
 
1868
 
1168
1869
    def approve(self, value=True):
1169
 
        self.send_changedstate()
1170
1870
        self.approved = value
1171
 
        gobject.timeout_add(timedelta_to_milliseconds
1172
 
                            (self.approval_duration),
1173
 
                            self._reset_approved)
1174
 
    
1175
 
    
1176
 
    ## D-Bus methods, signals & properties
1177
 
    _interface = "se.recompile.Mandos.Client"
1178
 
    
1179
 
    ## Signals
1180
 
    
 
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
 
1181
1881
    # CheckerCompleted - signal
1182
1882
    @dbus.service.signal(_interface, signature="nxs")
1183
1883
    def CheckerCompleted(self, exitcode, waitstatus, command):
1184
1884
        "D-Bus signal"
1185
1885
        pass
1186
 
    
 
1886
 
1187
1887
    # CheckerStarted - signal
1188
1888
    @dbus.service.signal(_interface, signature="s")
1189
1889
    def CheckerStarted(self, command):
1190
1890
        "D-Bus signal"
1191
1891
        pass
1192
 
    
 
1892
 
1193
1893
    # PropertyChanged - signal
 
1894
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1194
1895
    @dbus.service.signal(_interface, signature="sv")
1195
1896
    def PropertyChanged(self, property, value):
1196
1897
        "D-Bus signal"
1197
1898
        pass
1198
 
    
 
1899
 
1199
1900
    # GotSecret - signal
1200
1901
    @dbus.service.signal(_interface)
1201
1902
    def GotSecret(self):
1204
1905
        server to mandos-client
1205
1906
        """
1206
1907
        pass
1207
 
    
 
1908
 
1208
1909
    # Rejected - signal
1209
1910
    @dbus.service.signal(_interface, signature="s")
1210
1911
    def Rejected(self, reason):
1211
1912
        "D-Bus signal"
1212
1913
        pass
1213
 
    
 
1914
 
1214
1915
    # NeedApproval - signal
1215
1916
    @dbus.service.signal(_interface, signature="tb")
1216
1917
    def NeedApproval(self, timeout, default):
1217
1918
        "D-Bus signal"
1218
1919
        return self.need_approval()
1219
 
    
1220
 
    # NeRwequest - signal
1221
 
    @dbus.service.signal(_interface, signature="s")
1222
 
    def NewRequest(self, ip):
1223
 
        """D-Bus signal
1224
 
        Is sent after a client request a password.
1225
 
        """
1226
 
        pass
1227
 
    
1228
 
    ## Methods
1229
 
    
 
1920
 
 
1921
    #  Methods
 
1922
 
1230
1923
    # Approve - method
1231
1924
    @dbus.service.method(_interface, in_signature="b")
1232
1925
    def Approve(self, value):
1233
1926
        self.approve(value)
1234
 
    
 
1927
 
1235
1928
    # CheckedOK - method
1236
1929
    @dbus.service.method(_interface)
1237
1930
    def CheckedOK(self):
1238
1931
        self.checked_ok()
1239
 
    
 
1932
 
1240
1933
    # Enable - method
 
1934
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1241
1935
    @dbus.service.method(_interface)
1242
1936
    def Enable(self):
1243
1937
        "D-Bus method"
1244
1938
        self.enable()
1245
 
    
 
1939
 
1246
1940
    # StartChecker - method
 
1941
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1247
1942
    @dbus.service.method(_interface)
1248
1943
    def StartChecker(self):
1249
1944
        "D-Bus method"
1250
1945
        self.start_checker()
1251
 
    
 
1946
 
1252
1947
    # Disable - method
 
1948
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1253
1949
    @dbus.service.method(_interface)
1254
1950
    def Disable(self):
1255
1951
        "D-Bus method"
1256
1952
        self.disable()
1257
 
    
 
1953
 
1258
1954
    # StopChecker - method
 
1955
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1259
1956
    @dbus.service.method(_interface)
1260
1957
    def StopChecker(self):
1261
1958
        self.stop_checker()
1262
 
    
1263
 
    ## Properties
1264
 
    
 
1959
 
 
1960
    #  Properties
 
1961
 
1265
1962
    # ApprovalPending - property
1266
1963
    @dbus_service_property(_interface, signature="b", access="read")
1267
1964
    def ApprovalPending_dbus_property(self):
1268
1965
        return dbus.Boolean(bool(self.approvals_pending))
1269
 
    
 
1966
 
1270
1967
    # ApprovedByDefault - property
1271
 
    @dbus_service_property(_interface, signature="b",
 
1968
    @dbus_service_property(_interface,
 
1969
                           signature="b",
1272
1970
                           access="readwrite")
1273
1971
    def ApprovedByDefault_dbus_property(self, value=None):
1274
1972
        if value is None:       # get
1275
1973
            return dbus.Boolean(self.approved_by_default)
1276
1974
        self.approved_by_default = bool(value)
1277
 
    
 
1975
 
1278
1976
    # ApprovalDelay - property
1279
 
    @dbus_service_property(_interface, signature="t",
 
1977
    @dbus_service_property(_interface,
 
1978
                           signature="t",
1280
1979
                           access="readwrite")
1281
1980
    def ApprovalDelay_dbus_property(self, value=None):
1282
1981
        if value is None:       # get
1283
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1982
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1983
                               * 1000)
1284
1984
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1285
 
    
 
1985
 
1286
1986
    # ApprovalDuration - property
1287
 
    @dbus_service_property(_interface, signature="t",
 
1987
    @dbus_service_property(_interface,
 
1988
                           signature="t",
1288
1989
                           access="readwrite")
1289
1990
    def ApprovalDuration_dbus_property(self, value=None):
1290
1991
        if value is None:       # get
1291
 
            return dbus.UInt64(timedelta_to_milliseconds(
1292
 
                    self.approval_duration))
 
1992
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1993
                               * 1000)
1293
1994
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1294
 
    
 
1995
 
1295
1996
    # Name - property
 
1997
    @dbus_annotations(
 
1998
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1296
1999
    @dbus_service_property(_interface, signature="s", access="read")
1297
2000
    def Name_dbus_property(self):
1298
2001
        return dbus.String(self.name)
1299
 
    
 
2002
 
1300
2003
    # Fingerprint - property
 
2004
    @dbus_annotations(
 
2005
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1301
2006
    @dbus_service_property(_interface, signature="s", access="read")
1302
2007
    def Fingerprint_dbus_property(self):
1303
2008
        return dbus.String(self.fingerprint)
1304
 
    
 
2009
 
1305
2010
    # Host - property
1306
 
    @dbus_service_property(_interface, signature="s",
 
2011
    @dbus_service_property(_interface,
 
2012
                           signature="s",
1307
2013
                           access="readwrite")
1308
2014
    def Host_dbus_property(self, value=None):
1309
2015
        if value is None:       # get
1310
2016
            return dbus.String(self.host)
1311
 
        self.host = unicode(value)
1312
 
    
 
2017
        self.host = str(value)
 
2018
 
1313
2019
    # Created - property
 
2020
    @dbus_annotations(
 
2021
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1314
2022
    @dbus_service_property(_interface, signature="s", access="read")
1315
2023
    def Created_dbus_property(self):
1316
2024
        return datetime_to_dbus(self.created)
1317
 
    
 
2025
 
1318
2026
    # LastEnabled - property
1319
2027
    @dbus_service_property(_interface, signature="s", access="read")
1320
2028
    def LastEnabled_dbus_property(self):
1321
2029
        return datetime_to_dbus(self.last_enabled)
1322
 
    
 
2030
 
1323
2031
    # Enabled - property
1324
 
    @dbus_service_property(_interface, signature="b",
 
2032
    @dbus_service_property(_interface,
 
2033
                           signature="b",
1325
2034
                           access="readwrite")
1326
2035
    def Enabled_dbus_property(self, value=None):
1327
2036
        if value is None:       # get
1330
2039
            self.enable()
1331
2040
        else:
1332
2041
            self.disable()
1333
 
    
 
2042
 
1334
2043
    # LastCheckedOK - property
1335
 
    @dbus_service_property(_interface, signature="s",
 
2044
    @dbus_service_property(_interface,
 
2045
                           signature="s",
1336
2046
                           access="readwrite")
1337
2047
    def LastCheckedOK_dbus_property(self, value=None):
1338
2048
        if value is not None:
1339
2049
            self.checked_ok()
1340
2050
            return
1341
2051
        return datetime_to_dbus(self.last_checked_ok)
1342
 
    
 
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
 
1343
2058
    # Expires - property
1344
2059
    @dbus_service_property(_interface, signature="s", access="read")
1345
2060
    def Expires_dbus_property(self):
1346
2061
        return datetime_to_dbus(self.expires)
1347
 
    
 
2062
 
1348
2063
    # LastApprovalRequest - property
1349
2064
    @dbus_service_property(_interface, signature="s", access="read")
1350
2065
    def LastApprovalRequest_dbus_property(self):
1351
2066
        return datetime_to_dbus(self.last_approval_request)
1352
 
    
 
2067
 
1353
2068
    # Timeout - property
1354
 
    @dbus_service_property(_interface, signature="t",
 
2069
    @dbus_service_property(_interface,
 
2070
                           signature="t",
1355
2071
                           access="readwrite")
1356
2072
    def Timeout_dbus_property(self, value=None):
1357
2073
        if value is None:       # get
1358
 
            return dbus.UInt64(self.timeout_milliseconds())
 
2074
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
2075
        old_timeout = self.timeout
1359
2076
        self.timeout = datetime.timedelta(0, 0, 0, value)
1360
 
        if getattr(self, "disable_initiator_tag", None) is None:
1361
 
            return
1362
 
        # Reschedule timeout
1363
 
        gobject.source_remove(self.disable_initiator_tag)
1364
 
        self.disable_initiator_tag = None
1365
 
        self.expires = None
1366
 
        time_to_die = timedelta_to_milliseconds((self
1367
 
                                                 .last_checked_ok
1368
 
                                                 + self.timeout)
1369
 
                                                - datetime.datetime
1370
 
                                                .utcnow())
1371
 
        if time_to_die <= 0:
1372
 
            # The timeout has passed
1373
 
            self.disable()
1374
 
        else:
1375
 
            self.expires = (datetime.datetime.utcnow()
1376
 
                            + datetime.timedelta(milliseconds =
1377
 
                                                 time_to_die))
1378
 
            self.disable_initiator_tag = (gobject.timeout_add
1379
 
                                          (time_to_die, self.disable))
1380
 
    
 
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
 
1381
2093
    # ExtendedTimeout - property
1382
 
    @dbus_service_property(_interface, signature="t",
 
2094
    @dbus_service_property(_interface,
 
2095
                           signature="t",
1383
2096
                           access="readwrite")
1384
2097
    def ExtendedTimeout_dbus_property(self, value=None):
1385
2098
        if value is None:       # get
1386
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
2099
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
2100
                               * 1000)
1387
2101
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1388
 
    
 
2102
 
1389
2103
    # Interval - property
1390
 
    @dbus_service_property(_interface, signature="t",
 
2104
    @dbus_service_property(_interface,
 
2105
                           signature="t",
1391
2106
                           access="readwrite")
1392
2107
    def Interval_dbus_property(self, value=None):
1393
2108
        if value is None:       # get
1394
 
            return dbus.UInt64(self.interval_milliseconds())
 
2109
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1395
2110
        self.interval = datetime.timedelta(0, 0, 0, value)
1396
2111
        if getattr(self, "checker_initiator_tag", None) is None:
1397
2112
            return
1398
2113
        if self.enabled:
1399
2114
            # Reschedule checker run
1400
 
            gobject.source_remove(self.checker_initiator_tag)
1401
 
            self.checker_initiator_tag = (gobject.timeout_add
1402
 
                                          (value, self.start_checker))
1403
 
            self.start_checker()    # Start one now, too
1404
 
    
 
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
 
1405
2120
    # Checker - property
1406
 
    @dbus_service_property(_interface, signature="s",
 
2121
    @dbus_service_property(_interface,
 
2122
                           signature="s",
1407
2123
                           access="readwrite")
1408
2124
    def Checker_dbus_property(self, value=None):
1409
2125
        if value is None:       # get
1410
2126
            return dbus.String(self.checker_command)
1411
 
        self.checker_command = unicode(value)
1412
 
    
 
2127
        self.checker_command = str(value)
 
2128
 
1413
2129
    # CheckerRunning - property
1414
 
    @dbus_service_property(_interface, signature="b",
 
2130
    @dbus_service_property(_interface,
 
2131
                           signature="b",
1415
2132
                           access="readwrite")
1416
2133
    def CheckerRunning_dbus_property(self, value=None):
1417
2134
        if value is None:       # get
1420
2137
            self.start_checker()
1421
2138
        else:
1422
2139
            self.stop_checker()
1423
 
    
 
2140
 
1424
2141
    # ObjectPath - property
 
2142
    @dbus_annotations(
 
2143
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2144
         "org.freedesktop.DBus.Deprecated": "true"})
1425
2145
    @dbus_service_property(_interface, signature="o", access="read")
1426
2146
    def ObjectPath_dbus_property(self):
1427
 
        return self.dbus_object_path # is already a dbus.ObjectPath
1428
 
    
 
2147
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
2148
 
1429
2149
    # Secret = property
1430
 
    @dbus_service_property(_interface, signature="ay",
1431
 
                           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)
1432
2157
    def Secret_dbus_property(self, value):
1433
 
        self.secret = str(value)
1434
 
    
 
2158
        self.secret = bytes(value)
 
2159
 
1435
2160
    del _interface
1436
2161
 
1437
2162
 
1440
2165
        self._pipe = child_pipe
1441
2166
        self._pipe.send(('init', fpr, address))
1442
2167
        if not self._pipe.recv():
1443
 
            raise KeyError()
1444
 
    
 
2168
            raise KeyError(fpr)
 
2169
 
1445
2170
    def __getattribute__(self, name):
1446
2171
        if name == '_pipe':
1447
2172
            return super(ProxyClient, self).__getattribute__(name)
1450
2175
        if data[0] == 'data':
1451
2176
            return data[1]
1452
2177
        if data[0] == 'function':
 
2178
 
1453
2179
            def func(*args, **kwargs):
1454
2180
                self._pipe.send(('funcall', name, args, kwargs))
1455
2181
                return self._pipe.recv()[1]
 
2182
 
1456
2183
            return func
1457
 
    
 
2184
 
1458
2185
    def __setattr__(self, name, value):
1459
2186
        if name == '_pipe':
1460
2187
            return super(ProxyClient, self).__setattr__(name, value)
1461
2188
        self._pipe.send(('setattr', name, value))
1462
2189
 
1463
2190
 
1464
 
class ClientDBusTransitional(ClientDBus):
1465
 
    __metaclass__ = AlternateDBusNamesMetaclass
1466
 
 
1467
 
 
1468
2191
class ClientHandler(socketserver.BaseRequestHandler, object):
1469
2192
    """A class to handle client connections.
1470
 
    
 
2193
 
1471
2194
    Instantiated once for each connection to handle it.
1472
2195
    Note: This will run in its own forked process."""
1473
 
    
 
2196
 
1474
2197
    def handle(self):
1475
2198
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1476
2199
            logger.info("TCP connection from: %s",
1477
 
                        unicode(self.client_address))
 
2200
                        str(self.client_address))
1478
2201
            logger.debug("Pipe FD: %d",
1479
2202
                         self.server.child_pipe.fileno())
1480
 
            
1481
 
            session = (gnutls.connection
1482
 
                       .ClientSession(self.request,
1483
 
                                      gnutls.connection
1484
 
                                      .X509Credentials()))
1485
 
            
1486
 
            # Note: gnutls.connection.X509Credentials is really a
1487
 
            # generic GnuTLS certificate credentials object so long as
1488
 
            # no X.509 keys are added to it.  Therefore, we can use it
1489
 
            # here despite using OpenPGP certificates.
1490
 
            
1491
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1492
 
            #                      "+AES-256-CBC", "+SHA1",
1493
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1494
 
            #                      "+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"))
1495
2210
            # Use a fallback default, since this MUST be set.
1496
2211
            priority = self.server.gnutls_priority
1497
2212
            if priority is None:
1498
2213
                priority = "NORMAL"
1499
 
            (gnutls.library.functions
1500
 
             .gnutls_priority_set_direct(session._c_object,
1501
 
                                         priority, None))
1502
 
            
 
2214
            gnutls.priority_set_direct(session._c_object,
 
2215
                                       priority.encode("utf-8"),
 
2216
                                       None)
 
2217
 
1503
2218
            # Start communication using the Mandos protocol
1504
2219
            # Get protocol number
1505
2220
            line = self.request.makefile().readline()
1506
2221
            logger.debug("Protocol version: %r", line)
1507
2222
            try:
1508
2223
                if int(line.strip().split()[0]) > 1:
1509
 
                    raise RuntimeError
 
2224
                    raise RuntimeError(line)
1510
2225
            except (ValueError, IndexError, RuntimeError) as error:
1511
2226
                logger.error("Unknown protocol version: %s", error)
1512
2227
                return
1513
 
            
 
2228
 
1514
2229
            # Start GnuTLS connection
1515
2230
            try:
1516
2231
                session.handshake()
1517
 
            except gnutls.errors.GNUTLSError as error:
 
2232
            except gnutls.Error as error:
1518
2233
                logger.warning("Handshake failed: %s", error)
1519
2234
                # Do not run session.bye() here: the session is not
1520
2235
                # established.  Just abandon the request.
1521
2236
                return
1522
2237
            logger.debug("Handshake succeeded")
1523
 
            
 
2238
 
1524
2239
            approval_required = False
1525
2240
            try:
1526
2241
                try:
1527
 
                    fpr = self.fingerprint(self.peer_certificate
1528
 
                                           (session))
1529
 
                except (TypeError,
1530
 
                        gnutls.errors.GNUTLSError) as error:
 
2242
                    fpr = self.fingerprint(
 
2243
                        self.peer_certificate(session))
 
2244
                except (TypeError, gnutls.Error) as error:
1531
2245
                    logger.warning("Bad certificate: %s", error)
1532
2246
                    return
1533
2247
                logger.debug("Fingerprint: %s", fpr)
1534
 
                
 
2248
 
1535
2249
                try:
1536
2250
                    client = ProxyClient(child_pipe, fpr,
1537
2251
                                         self.client_address)
1538
2252
                except KeyError:
1539
2253
                    return
1540
 
                
1541
 
                if self.server.use_dbus:
1542
 
                    # Emit D-Bus signal
1543
 
                    client.NewRequest(str(self.client_address))
1544
 
                
 
2254
 
1545
2255
                if client.approval_delay:
1546
2256
                    delay = client.approval_delay
1547
2257
                    client.approvals_pending += 1
1548
2258
                    approval_required = True
1549
 
                
 
2259
 
1550
2260
                while True:
1551
2261
                    if not client.enabled:
1552
2262
                        logger.info("Client %s is disabled",
1553
 
                                       client.name)
 
2263
                                    client.name)
1554
2264
                        if self.server.use_dbus:
1555
2265
                            # Emit D-Bus signal
1556
2266
                            client.Rejected("Disabled")
1557
2267
                        return
1558
 
                    
 
2268
 
1559
2269
                    if client.approved or not client.approval_delay:
1560
 
                        #We are approved or approval is disabled
 
2270
                        # We are approved or approval is disabled
1561
2271
                        break
1562
2272
                    elif client.approved is None:
1563
2273
                        logger.info("Client %s needs approval",
1565
2275
                        if self.server.use_dbus:
1566
2276
                            # Emit D-Bus signal
1567
2277
                            client.NeedApproval(
1568
 
                                client.approval_delay_milliseconds(),
1569
 
                                client.approved_by_default)
 
2278
                                client.approval_delay.total_seconds()
 
2279
                                * 1000, client.approved_by_default)
1570
2280
                    else:
1571
2281
                        logger.warning("Client %s was not approved",
1572
2282
                                       client.name)
1574
2284
                            # Emit D-Bus signal
1575
2285
                            client.Rejected("Denied")
1576
2286
                        return
1577
 
                    
1578
 
                    #wait until timeout or approved
 
2287
 
 
2288
                    # wait until timeout or approved
1579
2289
                    time = datetime.datetime.now()
1580
2290
                    client.changedstate.acquire()
1581
 
                    (client.changedstate.wait
1582
 
                     (float(client.timedelta_to_milliseconds(delay)
1583
 
                            / 1000)))
 
2291
                    client.changedstate.wait(delay.total_seconds())
1584
2292
                    client.changedstate.release()
1585
2293
                    time2 = datetime.datetime.now()
1586
2294
                    if (time2 - time) >= delay:
1596
2304
                            break
1597
2305
                    else:
1598
2306
                        delay -= time2 - time
1599
 
                
1600
 
                sent_size = 0
1601
 
                while sent_size < len(client.secret):
1602
 
                    try:
1603
 
                        sent = session.send(client.secret[sent_size:])
1604
 
                    except gnutls.errors.GNUTLSError as error:
1605
 
                        logger.warning("gnutls send failed")
1606
 
                        return
1607
 
                    logger.debug("Sent: %d, remaining: %d",
1608
 
                                 sent, len(client.secret)
1609
 
                                 - (sent_size + sent))
1610
 
                    sent_size += sent
1611
 
                
 
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
 
1612
2315
                logger.info("Sending secret to %s", client.name)
1613
2316
                # bump the timeout using extended_timeout
1614
 
                client.checked_ok(client.extended_timeout)
 
2317
                client.bump_timeout(client.extended_timeout)
1615
2318
                if self.server.use_dbus:
1616
2319
                    # Emit D-Bus signal
1617
2320
                    client.GotSecret()
1618
 
            
 
2321
 
1619
2322
            finally:
1620
2323
                if approval_required:
1621
2324
                    client.approvals_pending -= 1
1622
2325
                try:
1623
2326
                    session.bye()
1624
 
                except gnutls.errors.GNUTLSError as error:
1625
 
                    logger.warning("GnuTLS bye failed")
1626
 
    
 
2327
                except gnutls.Error as error:
 
2328
                    logger.warning("GnuTLS bye failed",
 
2329
                                   exc_info=error)
 
2330
 
1627
2331
    @staticmethod
1628
2332
    def peer_certificate(session):
1629
2333
        "Return the peer's OpenPGP certificate as a bytestring"
1630
2334
        # If not an OpenPGP certificate...
1631
 
        if (gnutls.library.functions
1632
 
            .gnutls_certificate_type_get(session._c_object)
1633
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1634
 
            # ...do the normal thing
1635
 
            return session.peer_certificate
 
2335
        if (gnutls.certificate_type_get(session._c_object)
 
2336
            != gnutls.CRT_OPENPGP):
 
2337
            # ...return invalid data
 
2338
            return b""
1636
2339
        list_size = ctypes.c_uint(1)
1637
 
        cert_list = (gnutls.library.functions
1638
 
                     .gnutls_certificate_get_peers
 
2340
        cert_list = (gnutls.certificate_get_peers
1639
2341
                     (session._c_object, ctypes.byref(list_size)))
1640
2342
        if not bool(cert_list) and list_size.value != 0:
1641
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1642
 
                                            " certificate")
 
2343
            raise gnutls.Error("error getting peer certificate")
1643
2344
        if list_size.value == 0:
1644
2345
            return None
1645
2346
        cert = cert_list[0]
1646
2347
        return ctypes.string_at(cert.data, cert.size)
1647
 
    
 
2348
 
1648
2349
    @staticmethod
1649
2350
    def fingerprint(openpgp):
1650
2351
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1651
2352
        # New GnuTLS "datum" with the OpenPGP public key
1652
 
        datum = (gnutls.library.types
1653
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1654
 
                                             ctypes.POINTER
1655
 
                                             (ctypes.c_ubyte)),
1656
 
                                 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)))
1657
2357
        # New empty GnuTLS certificate
1658
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1659
 
        (gnutls.library.functions
1660
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2358
        crt = gnutls.openpgp_crt_t()
 
2359
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1661
2360
        # Import the OpenPGP public key into the certificate
1662
 
        (gnutls.library.functions
1663
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1664
 
                                    gnutls.library.constants
1665
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2361
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2362
                                  gnutls.OPENPGP_FMT_RAW)
1666
2363
        # Verify the self signature in the key
1667
2364
        crtverify = ctypes.c_uint()
1668
 
        (gnutls.library.functions
1669
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1670
 
                                         ctypes.byref(crtverify)))
 
2365
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2366
                                       ctypes.byref(crtverify))
1671
2367
        if crtverify.value != 0:
1672
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1673
 
            raise (gnutls.errors.CertificateSecurityError
1674
 
                   ("Verify failed"))
 
2368
            gnutls.openpgp_crt_deinit(crt)
 
2369
            raise gnutls.CertificateSecurityError("Verify failed")
1675
2370
        # New buffer for the fingerprint
1676
2371
        buf = ctypes.create_string_buffer(20)
1677
2372
        buf_len = ctypes.c_size_t()
1678
2373
        # Get the fingerprint from the certificate into the buffer
1679
 
        (gnutls.library.functions
1680
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1681
 
                                             ctypes.byref(buf_len)))
 
2374
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2375
                                           ctypes.byref(buf_len))
1682
2376
        # Deinit the certificate
1683
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2377
        gnutls.openpgp_crt_deinit(crt)
1684
2378
        # Convert the buffer to a Python bytestring
1685
2379
        fpr = ctypes.string_at(buf, buf_len.value)
1686
2380
        # Convert the bytestring to hexadecimal notation
1690
2384
 
1691
2385
class MultiprocessingMixIn(object):
1692
2386
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2387
 
1693
2388
    def sub_process_main(self, request, address):
1694
2389
        try:
1695
2390
            self.finish_request(request, address)
1696
2391
        except Exception:
1697
2392
            self.handle_error(request, address)
1698
2393
        self.close_request(request)
1699
 
    
 
2394
 
1700
2395
    def process_request(self, request, address):
1701
2396
        """Start a new process to process the request."""
1702
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1703
 
                                       args = (request,
1704
 
                                               address))
 
2397
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2398
                                       args=(request, address))
1705
2399
        proc.start()
1706
2400
        return proc
1707
2401
 
1708
2402
 
1709
2403
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1710
2404
    """ adds a pipe to the MixIn """
 
2405
 
1711
2406
    def process_request(self, request, client_address):
1712
2407
        """Overrides and wraps the original process_request().
1713
 
        
 
2408
 
1714
2409
        This function creates a new pipe in self.pipe
1715
2410
        """
1716
2411
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1717
 
        
 
2412
 
1718
2413
        proc = MultiprocessingMixIn.process_request(self, request,
1719
2414
                                                    client_address)
1720
2415
        self.child_pipe.close()
1721
2416
        self.add_pipe(parent_pipe, proc)
1722
 
    
 
2417
 
1723
2418
    def add_pipe(self, parent_pipe, proc):
1724
2419
        """Dummy function; override as necessary"""
1725
 
        raise NotImplementedError
 
2420
        raise NotImplementedError()
1726
2421
 
1727
2422
 
1728
2423
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1729
2424
                     socketserver.TCPServer, object):
1730
2425
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1731
 
    
 
2426
 
1732
2427
    Attributes:
1733
2428
        enabled:        Boolean; whether this server is activated yet
1734
2429
        interface:      None or a network interface name (string)
1735
2430
        use_ipv6:       Boolean; to use IPv6 or not
1736
2431
    """
 
2432
 
1737
2433
    def __init__(self, server_address, RequestHandlerClass,
1738
 
                 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
        """
1739
2440
        self.interface = interface
1740
2441
        if use_ipv6:
1741
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.
1742
2470
        socketserver.TCPServer.__init__(self, server_address,
1743
2471
                                        RequestHandlerClass)
 
2472
 
1744
2473
    def server_bind(self):
1745
2474
        """This overrides the normal server_bind() function
1746
2475
        to bind to an interface if one was specified, and also NOT to
1747
2476
        bind to an address or port if they were not specified."""
 
2477
        global SO_BINDTODEVICE
1748
2478
        if self.interface is not None:
1749
2479
            if SO_BINDTODEVICE is None:
1750
 
                logger.error("SO_BINDTODEVICE does not exist;"
1751
 
                             " cannot bind to interface %s",
1752
 
                             self.interface)
1753
 
            else:
1754
 
                try:
1755
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1756
 
                                           SO_BINDTODEVICE,
1757
 
                                           str(self.interface
1758
 
                                               + '\0'))
1759
 
                except socket.error as error:
1760
 
                    if error[0] == errno.EPERM:
1761
 
                        logger.error("No permission to"
1762
 
                                     " bind to interface %s",
1763
 
                                     self.interface)
1764
 
                    elif error[0] == errno.ENOPROTOOPT:
1765
 
                        logger.error("SO_BINDTODEVICE not available;"
1766
 
                                     " cannot bind to interface %s",
1767
 
                                     self.interface)
1768
 
                    else:
1769
 
                        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
1770
2501
        # Only bind(2) the socket if we really need to.
1771
2502
        if self.server_address[0] or self.server_address[1]:
1772
2503
            if not self.server_address[0]:
1773
2504
                if self.address_family == socket.AF_INET6:
1774
 
                    any_address = "::" # in6addr_any
 
2505
                    any_address = "::"  # in6addr_any
1775
2506
                else:
1776
 
                    any_address = socket.INADDR_ANY
 
2507
                    any_address = "0.0.0.0"  # INADDR_ANY
1777
2508
                self.server_address = (any_address,
1778
2509
                                       self.server_address[1])
1779
2510
            elif not self.server_address[1]:
1780
 
                self.server_address = (self.server_address[0],
1781
 
                                       0)
 
2511
                self.server_address = (self.server_address[0], 0)
1782
2512
#                 if self.interface:
1783
2513
#                     self.server_address = (self.server_address[0],
1784
2514
#                                            0, # port
1790
2520
 
1791
2521
class MandosServer(IPv6_TCPServer):
1792
2522
    """Mandos server.
1793
 
    
 
2523
 
1794
2524
    Attributes:
1795
2525
        clients:        set of Client objects
1796
2526
        gnutls_priority GnuTLS priority string
1797
2527
        use_dbus:       Boolean; to emit D-Bus signals or not
1798
 
    
1799
 
    Assumes a gobject.MainLoop event loop.
 
2528
 
 
2529
    Assumes a GLib.MainLoop event loop.
1800
2530
    """
 
2531
 
1801
2532
    def __init__(self, server_address, RequestHandlerClass,
1802
 
                 interface=None, use_ipv6=True, clients=None,
1803
 
                 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):
1804
2539
        self.enabled = False
1805
2540
        self.clients = clients
1806
2541
        if self.clients is None:
1809
2544
        self.gnutls_priority = gnutls_priority
1810
2545
        IPv6_TCPServer.__init__(self, server_address,
1811
2546
                                RequestHandlerClass,
1812
 
                                interface = interface,
1813
 
                                use_ipv6 = use_ipv6)
 
2547
                                interface=interface,
 
2548
                                use_ipv6=use_ipv6,
 
2549
                                socketfd=socketfd)
 
2550
 
1814
2551
    def server_activate(self):
1815
2552
        if self.enabled:
1816
2553
            return socketserver.TCPServer.server_activate(self)
1817
 
    
 
2554
 
1818
2555
    def enable(self):
1819
2556
        self.enabled = True
1820
 
    
 
2557
 
1821
2558
    def add_pipe(self, parent_pipe, proc):
1822
2559
        # Call "handle_ipc" for both data and EOF events
1823
 
        gobject.io_add_watch(parent_pipe.fileno(),
1824
 
                             gobject.IO_IN | gobject.IO_HUP,
1825
 
                             functools.partial(self.handle_ipc,
1826
 
                                               parent_pipe =
1827
 
                                               parent_pipe,
1828
 
                                               proc = proc))
1829
 
    
1830
 
    def handle_ipc(self, source, condition, parent_pipe=None,
1831
 
                   proc = None, client_object=None):
1832
 
        condition_names = {
1833
 
            gobject.IO_IN: "IN",   # There is data to read.
1834
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1835
 
                                    # blocking).
1836
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1837
 
            gobject.IO_ERR: "ERR", # Error condition.
1838
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1839
 
                                    # broken, usually for pipes and
1840
 
                                    # sockets).
1841
 
            }
1842
 
        conditions_string = ' | '.join(name
1843
 
                                       for cond, name in
1844
 
                                       condition_names.iteritems()
1845
 
                                       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):
1846
2571
        # error, or the other end of multiprocessing.Pipe has closed
1847
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2572
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
1848
2573
            # Wait for other process to exit
1849
2574
            proc.join()
1850
2575
            return False
1851
 
        
 
2576
 
1852
2577
        # Read a request from the child
1853
2578
        request = parent_pipe.recv()
1854
2579
        command = request[0]
1855
 
        
 
2580
 
1856
2581
        if command == 'init':
1857
 
            fpr = request[1]
 
2582
            fpr = request[1].decode("ascii")
1858
2583
            address = request[2]
1859
 
            
1860
 
            for c in self.clients.itervalues():
 
2584
 
 
2585
            for c in self.clients.values():
1861
2586
                if c.fingerprint == fpr:
1862
2587
                    client = c
1863
2588
                    break
1870
2595
                                                       address[0])
1871
2596
                parent_pipe.send(False)
1872
2597
                return False
1873
 
            
1874
 
            gobject.io_add_watch(parent_pipe.fileno(),
1875
 
                                 gobject.IO_IN | gobject.IO_HUP,
1876
 
                                 functools.partial(self.handle_ipc,
1877
 
                                                   parent_pipe =
1878
 
                                                   parent_pipe,
1879
 
                                                   proc = proc,
1880
 
                                                   client_object =
1881
 
                                                   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))
1882
2606
            parent_pipe.send(True)
1883
2607
            # remove the old hook in favor of the new above hook on
1884
2608
            # same fileno
1887
2611
            funcname = request[1]
1888
2612
            args = request[2]
1889
2613
            kwargs = request[3]
1890
 
            
 
2614
 
1891
2615
            parent_pipe.send(('data', getattr(client_object,
1892
2616
                                              funcname)(*args,
1893
 
                                                         **kwargs)))
1894
 
        
 
2617
                                                        **kwargs)))
 
2618
 
1895
2619
        if command == 'getattr':
1896
2620
            attrname = request[1]
1897
 
            if callable(client_object.__getattribute__(attrname)):
1898
 
                parent_pipe.send(('function',))
 
2621
            if isinstance(client_object.__getattribute__(attrname),
 
2622
                          collections.Callable):
 
2623
                parent_pipe.send(('function', ))
1899
2624
            else:
1900
 
                parent_pipe.send(('data', client_object
1901
 
                                  .__getattribute__(attrname)))
1902
 
        
 
2625
                parent_pipe.send((
 
2626
                    'data', client_object.__getattribute__(attrname)))
 
2627
 
1903
2628
        if command == 'setattr':
1904
2629
            attrname = request[1]
1905
2630
            value = request[2]
1906
2631
            setattr(client_object, attrname, value)
1907
 
        
 
2632
 
1908
2633
        return True
1909
2634
 
1910
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
 
1911
2735
def string_to_delta(interval):
1912
2736
    """Parse a string and return a datetime.timedelta
1913
 
    
 
2737
 
1914
2738
    >>> string_to_delta('7d')
1915
2739
    datetime.timedelta(7)
1916
2740
    >>> string_to_delta('60s')
1924
2748
    >>> string_to_delta('5m 30s')
1925
2749
    datetime.timedelta(0, 330)
1926
2750
    """
 
2751
 
 
2752
    try:
 
2753
        return rfc3339_duration_to_delta(interval)
 
2754
    except ValueError:
 
2755
        pass
 
2756
 
1927
2757
    timevalue = datetime.timedelta(0)
1928
2758
    for s in interval.split():
1929
2759
        try:
1930
 
            suffix = unicode(s[-1])
 
2760
            suffix = s[-1]
1931
2761
            value = int(s[:-1])
1932
2762
            if suffix == "d":
1933
2763
                delta = datetime.timedelta(value)
1940
2770
            elif suffix == "w":
1941
2771
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1942
2772
            else:
1943
 
                raise ValueError("Unknown suffix %r" % suffix)
1944
 
        except (ValueError, IndexError) as e:
 
2773
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2774
        except IndexError as e:
1945
2775
            raise ValueError(*(e.args))
1946
2776
        timevalue += delta
1947
2777
    return timevalue
1948
2778
 
1949
2779
 
1950
 
def daemon(nochdir = False, noclose = False):
 
2780
def daemon(nochdir=False, noclose=False):
1951
2781
    """See daemon(3).  Standard BSD Unix function.
1952
 
    
 
2782
 
1953
2783
    This should really exist as os.daemon, but it doesn't (yet)."""
1954
2784
    if os.fork():
1955
2785
        sys.exit()
1960
2790
        sys.exit()
1961
2791
    if not noclose:
1962
2792
        # Close all standard open file descriptors
1963
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2793
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1964
2794
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1965
2795
            raise OSError(errno.ENODEV,
1966
 
                          "%s not a character device"
1967
 
                          % os.path.devnull)
 
2796
                          "{} not a character device"
 
2797
                          .format(os.devnull))
1968
2798
        os.dup2(null, sys.stdin.fileno())
1969
2799
        os.dup2(null, sys.stdout.fileno())
1970
2800
        os.dup2(null, sys.stderr.fileno())
1973
2803
 
1974
2804
 
1975
2805
def main():
1976
 
    
 
2806
 
1977
2807
    ##################################################################
1978
2808
    # Parsing of options, both command line and config file
1979
 
    
 
2809
 
1980
2810
    parser = argparse.ArgumentParser()
1981
2811
    parser.add_argument("-v", "--version", action="version",
1982
 
                        version = "%%(prog)s %s" % version,
 
2812
                        version="%(prog)s {}".format(version),
1983
2813
                        help="show version number and exit")
1984
2814
    parser.add_argument("-i", "--interface", metavar="IF",
1985
2815
                        help="Bind to interface IF")
1991
2821
                        help="Run self-test")
1992
2822
    parser.add_argument("--debug", action="store_true",
1993
2823
                        help="Debug mode; run in foreground and log"
1994
 
                        " to terminal")
 
2824
                        " to terminal", default=None)
1995
2825
    parser.add_argument("--debuglevel", metavar="LEVEL",
1996
2826
                        help="Debug level for stdout output")
1997
2827
    parser.add_argument("--priority", help="GnuTLS"
2004
2834
                        " files")
2005
2835
    parser.add_argument("--no-dbus", action="store_false",
2006
2836
                        dest="use_dbus", help="Do not provide D-Bus"
2007
 
                        " system bus interface")
 
2837
                        " system bus interface", default=None)
2008
2838
    parser.add_argument("--no-ipv6", action="store_false",
2009
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2839
                        dest="use_ipv6", help="Do not use IPv6",
 
2840
                        default=None)
2010
2841
    parser.add_argument("--no-restore", action="store_false",
2011
2842
                        dest="restore", help="Do not restore stored"
2012
 
                        " 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")
2013
2847
    parser.add_argument("--statedir", metavar="DIR",
2014
2848
                        help="Directory to save/restore state in")
2015
 
    
 
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
 
2016
2855
    options = parser.parse_args()
2017
 
    
 
2856
 
2018
2857
    if options.check:
2019
2858
        import doctest
2020
 
        doctest.testmod()
2021
 
        sys.exit()
2022
 
    
 
2859
        fail_count, test_count = doctest.testmod()
 
2860
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2861
 
2023
2862
    # Default values for config file for server-global settings
2024
 
    server_defaults = { "interface": "",
2025
 
                        "address": "",
2026
 
                        "port": "",
2027
 
                        "debug": "False",
2028
 
                        "priority":
2029
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2030
 
                        "servicename": "Mandos",
2031
 
                        "use_dbus": "True",
2032
 
                        "use_ipv6": "True",
2033
 
                        "debuglevel": "",
2034
 
                        "restore": "True",
2035
 
                        "statedir": "/var/lib/mandos"
2036
 
                        }
2037
 
    
 
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
 
2038
2881
    # Parse config file for server-global settings
2039
2882
    server_config = configparser.SafeConfigParser(server_defaults)
2040
2883
    del server_defaults
2041
 
    server_config.read(os.path.join(options.configdir,
2042
 
                                    "mandos.conf"))
 
2884
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2043
2885
    # Convert the SafeConfigParser object to a dict
2044
2886
    server_settings = server_config.defaults()
2045
2887
    # Use the appropriate methods on the non-string config options
2046
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2888
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2889
                   "foreground", "zeroconf"):
2047
2890
        server_settings[option] = server_config.getboolean("DEFAULT",
2048
2891
                                                           option)
2049
2892
    if server_settings["port"]:
2050
2893
        server_settings["port"] = server_config.getint("DEFAULT",
2051
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"])
2052
2904
    del server_config
2053
 
    
 
2905
 
2054
2906
    # Override the settings from the config file with command line
2055
2907
    # options, if set.
2056
2908
    for option in ("interface", "address", "port", "debug",
2057
 
                   "priority", "servicename", "configdir",
2058
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2059
 
                   "statedir"):
 
2909
                   "priority", "servicename", "configdir", "use_dbus",
 
2910
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2911
                   "socket", "foreground", "zeroconf"):
2060
2912
        value = getattr(options, option)
2061
2913
        if value is not None:
2062
2914
            server_settings[option] = value
2063
2915
    del options
2064
2916
    # Force all strings to be unicode
2065
2917
    for option in server_settings.keys():
2066
 
        if type(server_settings[option]) is str:
2067
 
            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
2068
2928
    # Now we have our good server settings in "server_settings"
2069
 
    
 
2929
 
2070
2930
    ##################################################################
2071
 
    
 
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
 
2072
2937
    # For convenience
2073
2938
    debug = server_settings["debug"]
2074
2939
    debuglevel = server_settings["debuglevel"]
2076
2941
    use_ipv6 = server_settings["use_ipv6"]
2077
2942
    stored_state_path = os.path.join(server_settings["statedir"],
2078
2943
                                     stored_state_file)
2079
 
    
 
2944
    foreground = server_settings["foreground"]
 
2945
    zeroconf = server_settings["zeroconf"]
 
2946
 
2080
2947
    if debug:
2081
 
        initlogger(logging.DEBUG)
 
2948
        initlogger(debug, logging.DEBUG)
2082
2949
    else:
2083
2950
        if not debuglevel:
2084
 
            initlogger()
 
2951
            initlogger(debug)
2085
2952
        else:
2086
2953
            level = getattr(logging, debuglevel.upper())
2087
 
            initlogger(level)
2088
 
    
 
2954
            initlogger(debug, level)
 
2955
 
2089
2956
    if server_settings["servicename"] != "Mandos":
2090
 
        syslogger.setFormatter(logging.Formatter
2091
 
                               ('Mandos (%s) [%%(process)d]:'
2092
 
                                ' %%(levelname)s: %%(message)s'
2093
 
                                % server_settings["servicename"]))
2094
 
    
 
2957
        syslogger.setFormatter(
 
2958
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2959
                              ' %(levelname)s: %(message)s'.format(
 
2960
                                  server_settings["servicename"])))
 
2961
 
2095
2962
    # Parse config file with clients
2096
 
    client_config = configparser.SafeConfigParser(Client.client_defaults)
 
2963
    client_config = configparser.SafeConfigParser(Client
 
2964
                                                  .client_defaults)
2097
2965
    client_config.read(os.path.join(server_settings["configdir"],
2098
2966
                                    "clients.conf"))
2099
 
    
 
2967
 
2100
2968
    global mandos_dbus_service
2101
2969
    mandos_dbus_service = None
2102
 
    
2103
 
    tcp_server = MandosServer((server_settings["address"],
2104
 
                               server_settings["port"]),
2105
 
                              ClientHandler,
2106
 
                              interface=(server_settings["interface"]
2107
 
                                         or None),
2108
 
                              use_ipv6=use_ipv6,
2109
 
                              gnutls_priority=
2110
 
                              server_settings["priority"],
2111
 
                              use_dbus=use_dbus)
2112
 
    if not debug:
2113
 
        pidfilename = "/var/run/mandos.pid"
2114
 
        try:
2115
 
            pidfile = open(pidfilename, "w")
2116
 
        except IOError:
2117
 
            logger.error("Could not open file %r", pidfilename)
2118
 
    
2119
 
    try:
2120
 
        uid = pwd.getpwnam("_mandos").pw_uid
2121
 
        gid = pwd.getpwnam("_mandos").pw_gid
2122
 
    except KeyError:
2123
 
        try:
2124
 
            uid = pwd.getpwnam("mandos").pw_uid
2125
 
            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
2126
3000
        except KeyError:
2127
 
            try:
2128
 
                uid = pwd.getpwnam("nobody").pw_uid
2129
 
                gid = pwd.getpwnam("nobody").pw_gid
2130
 
            except KeyError:
2131
 
                uid = 65534
2132
 
                gid = 65534
 
3001
            continue
 
3002
    else:
 
3003
        uid = 65534
 
3004
        gid = 65534
2133
3005
    try:
2134
3006
        os.setgid(gid)
2135
3007
        os.setuid(uid)
 
3008
        if debug:
 
3009
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3010
                                                             gid))
2136
3011
    except OSError as error:
2137
 
        if error[0] != errno.EPERM:
2138
 
            raise error
2139
 
    
 
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
 
2140
3017
    if debug:
2141
3018
        # Enable all possible GnuTLS debugging
2142
 
        
 
3019
 
2143
3020
        # "Use a log level over 10 to enable all debugging options."
2144
3021
        # - GnuTLS manual
2145
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
2146
 
        
2147
 
        @gnutls.library.types.gnutls_log_func
 
3022
        gnutls.global_set_log_level(11)
 
3023
 
 
3024
        @gnutls.log_func
2148
3025
        def debug_gnutls(level, string):
2149
3026
            logger.debug("GnuTLS: %s", string[:-1])
2150
 
        
2151
 
        (gnutls.library.functions
2152
 
         .gnutls_global_set_log_function(debug_gnutls))
2153
 
        
 
3027
 
 
3028
        gnutls.global_set_log_function(debug_gnutls)
 
3029
 
2154
3030
        # Redirect stdin so all checkers get /dev/null
2155
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
3031
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
3032
        os.dup2(null, sys.stdin.fileno())
2157
3033
        if null > 2:
2158
3034
            os.close(null)
2159
 
    else:
2160
 
        # No console logging
2161
 
        logger.removeHandler(console)
2162
 
    
 
3035
 
2163
3036
    # Need to fork before connecting to D-Bus
2164
 
    if not debug:
 
3037
    if not foreground:
2165
3038
        # Close all input and output, do double fork, etc.
2166
3039
        daemon()
2167
 
    
 
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
 
2168
3045
    global main_loop
2169
3046
    # From the Avahi example code
2170
 
    DBusGMainLoop(set_as_default=True )
2171
 
    main_loop = gobject.MainLoop()
 
3047
    DBusGMainLoop(set_as_default=True)
 
3048
    main_loop = GLib.MainLoop()
2172
3049
    bus = dbus.SystemBus()
2173
3050
    # End of Avahi example code
2174
3051
    if use_dbus:
2175
3052
        try:
2176
3053
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2177
 
                                            bus, do_not_queue=True)
2178
 
            old_bus_name = (dbus.service.BusName
2179
 
                            ("se.bsnet.fukt.Mandos", bus,
2180
 
                             do_not_queue=True))
2181
 
        except dbus.exceptions.NameExistsException as e:
2182
 
            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)
2183
3061
            use_dbus = False
2184
3062
            server_settings["use_dbus"] = False
2185
3063
            tcp_server.use_dbus = False
2186
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2187
 
    service = AvahiServiceToSyslog(name =
2188
 
                                   server_settings["servicename"],
2189
 
                                   servicetype = "_mandos._tcp",
2190
 
                                   protocol = protocol, bus = bus)
2191
 
    if server_settings["interface"]:
2192
 
        service.interface = (if_nametoindex
2193
 
                             (str(server_settings["interface"])))
2194
 
    
 
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
 
2195
3075
    global multiprocessing_manager
2196
3076
    multiprocessing_manager = multiprocessing.Manager()
2197
 
    
 
3077
 
2198
3078
    client_class = Client
2199
3079
    if use_dbus:
2200
 
        client_class = functools.partial(ClientDBusTransitional,
2201
 
                                         bus = bus)
2202
 
    
 
3080
        client_class = functools.partial(ClientDBus, bus=bus)
 
3081
 
2203
3082
    client_settings = Client.config_parser(client_config)
2204
3083
    old_client_settings = {}
2205
3084
    clients_data = {}
2206
 
    
 
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
 
2207
3094
    # Get client data and settings from last running state.
2208
3095
    if server_settings["restore"]:
2209
3096
        try:
2210
3097
            with open(stored_state_path, "rb") as stored_state:
2211
 
                clients_data, old_client_settings = (pickle.load
2212
 
                                                     (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"))
2213
3143
            os.remove(stored_state_path)
2214
3144
        except IOError as e:
2215
 
            logger.warning("Could not load persistent state: {0}"
2216
 
                           .format(e))
2217
 
            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)
2218
3151
                raise
2219
 
    
 
3152
        except EOFError as e:
 
3153
            logger.warning("Could not load persistent state: "
 
3154
                           "EOFError:",
 
3155
                           exc_info=e)
 
3156
 
2220
3157
    with PGPEngine() as pgp:
2221
 
        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
 
2222
3163
            # Decide which value to use after restoring saved state.
2223
3164
            # We have three different values: Old config file,
2224
3165
            # new config file, and saved state.
2229
3170
                    # For each value in new config, check if it
2230
3171
                    # differs from the old config value (Except for
2231
3172
                    # the "secret" attribute)
2232
 
                    if (name != "secret" and
2233
 
                        value != old_client_settings[client_name]
2234
 
                        [name]):
 
3173
                    if (name != "secret"
 
3174
                        and (value !=
 
3175
                             old_client_settings[client_name][name])):
2235
3176
                        client[name] = value
2236
3177
                except KeyError:
2237
3178
                    pass
2238
 
            
 
3179
 
2239
3180
            # Clients who has passed its expire date can still be
2240
 
            # enabled if its last checker was successful.  Clients
2241
 
            # whose checker failed before we stored its state is
2242
 
            # 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.
2243
3185
            if client["enabled"]:
2244
3186
                if datetime.datetime.utcnow() >= client["expires"]:
2245
3187
                    if not client["last_checked_ok"]:
2246
3188
                        logger.warning(
2247
 
                            "disabling client {0} - Client never "
2248
 
                            "performed a successfull checker"
2249
 
                            .format(client["name"]))
 
3189
                            "disabling client {} - Client never "
 
3190
                            "performed a successful checker".format(
 
3191
                                client_name))
2250
3192
                        client["enabled"] = False
2251
3193
                    elif client["last_checker_status"] != 0:
2252
3194
                        logger.warning(
2253
 
                            "disabling client {0} - Client "
2254
 
                            "last checker failed with error code {1}"
2255
 
                            .format(client["name"],
2256
 
                                    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"]))
2257
3200
                        client["enabled"] = False
2258
3201
                    else:
2259
 
                        client["expires"] = (datetime.datetime
2260
 
                                             .utcnow()
2261
 
                                             + client["timeout"])
2262
 
                    
 
3202
                        client["expires"] = (
 
3203
                            datetime.datetime.utcnow()
 
3204
                            + client["timeout"])
 
3205
                        logger.debug("Last checker succeeded,"
 
3206
                                     " keeping {} enabled".format(
 
3207
                                         client_name))
2263
3208
            try:
2264
 
                client["secret"] = (
2265
 
                    pgp.decrypt(client["encrypted_secret"],
2266
 
                                client_settings[client_name]
2267
 
                                ["secret"]))
 
3209
                client["secret"] = pgp.decrypt(
 
3210
                    client["encrypted_secret"],
 
3211
                    client_settings[client_name]["secret"])
2268
3212
            except PGPError:
2269
3213
                # If decryption fails, we use secret from new settings
2270
 
                logger.debug("Failed to decrypt {0} old secret"
2271
 
                             .format(client_name))
2272
 
                client["secret"] = (
2273
 
                    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"])
2274
3218
 
2275
 
    
2276
3219
    # Add/remove clients based on new changes made to config
2277
 
    for client_name in set(old_client_settings) - set(client_settings):
 
3220
    for client_name in (set(old_client_settings)
 
3221
                        - set(client_settings)):
2278
3222
        del clients_data[client_name]
2279
 
    for client_name in set(client_settings) - set(old_client_settings):
 
3223
    for client_name in (set(client_settings)
 
3224
                        - set(old_client_settings)):
2280
3225
        clients_data[client_name] = client_settings[client_name]
2281
3226
 
2282
 
    # Create clients all clients
2283
 
    for client_name, client in clients_data.iteritems():
 
3227
    # Create all client objects
 
3228
    for client_name, client in clients_data.items():
2284
3229
        tcp_server.clients[client_name] = client_class(
2285
 
            name = client_name, settings = client)
2286
 
    
 
3230
            name=client_name,
 
3231
            settings=client,
 
3232
            server_settings=server_settings)
 
3233
 
2287
3234
    if not tcp_server.clients:
2288
3235
        logger.warning("No clients defined")
2289
 
        
2290
 
    if not debug:
2291
 
        try:
2292
 
            with pidfile:
2293
 
                pid = os.getpid()
2294
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2295
 
            del pidfile
2296
 
        except IOError:
2297
 
            logger.error("Could not write to file %r with PID %d",
2298
 
                         pidfilename, pid)
2299
 
        except NameError:
2300
 
            # "pidfile" was never created
2301
 
            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
2302
3247
        del pidfilename
2303
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2304
 
    
2305
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2306
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2307
 
    
 
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
 
2308
3253
    if use_dbus:
2309
 
        class MandosDBusService(dbus.service.Object):
 
3254
 
 
3255
        @alternate_dbus_interfaces(
 
3256
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3257
        class MandosDBusService(DBusObjectWithObjectManager):
2310
3258
            """A D-Bus proxy object"""
 
3259
 
2311
3260
            def __init__(self):
2312
3261
                dbus.service.Object.__init__(self, bus, "/")
 
3262
 
2313
3263
            _interface = "se.recompile.Mandos"
2314
 
            
 
3264
 
2315
3265
            @dbus.service.signal(_interface, signature="o")
2316
3266
            def ClientAdded(self, objpath):
2317
3267
                "D-Bus signal"
2318
3268
                pass
2319
 
            
 
3269
 
2320
3270
            @dbus.service.signal(_interface, signature="ss")
2321
3271
            def ClientNotFound(self, fingerprint, address):
2322
3272
                "D-Bus signal"
2323
3273
                pass
2324
 
            
 
3274
 
 
3275
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3276
                               "true"})
2325
3277
            @dbus.service.signal(_interface, signature="os")
2326
3278
            def ClientRemoved(self, objpath, name):
2327
3279
                "D-Bus signal"
2328
3280
                pass
2329
 
            
 
3281
 
 
3282
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3283
                               "true"})
2330
3284
            @dbus.service.method(_interface, out_signature="ao")
2331
3285
            def GetAllClients(self):
2332
3286
                "D-Bus method"
2333
 
                return dbus.Array(c.dbus_object_path
2334
 
                                  for c in
2335
 
                                  tcp_server.clients.itervalues())
2336
 
            
 
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"})
2337
3292
            @dbus.service.method(_interface,
2338
3293
                                 out_signature="a{oa{sv}}")
2339
3294
            def GetAllClientsWithProperties(self):
2340
3295
                "D-Bus method"
2341
3296
                return dbus.Dictionary(
2342
 
                    ((c.dbus_object_path, c.GetAll(""))
2343
 
                     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()},
2344
3300
                    signature="oa{sv}")
2345
 
            
 
3301
 
2346
3302
            @dbus.service.method(_interface, in_signature="o")
2347
3303
            def RemoveClient(self, object_path):
2348
3304
                "D-Bus method"
2349
 
                for c in tcp_server.clients.itervalues():
 
3305
                for c in tcp_server.clients.values():
2350
3306
                    if c.dbus_object_path == object_path:
2351
3307
                        del tcp_server.clients[c.name]
2352
3308
                        c.remove_from_connection()
2353
 
                        # Don't signal anything except ClientRemoved
 
3309
                        # Don't signal the disabling
2354
3310
                        c.disable(quiet=True)
2355
 
                        # Emit D-Bus signal
2356
 
                        self.ClientRemoved(object_path, c.name)
 
3311
                        # Emit D-Bus signal for removal
 
3312
                        self.client_removed_signal(c)
2357
3313
                        return
2358
3314
                raise KeyError(object_path)
2359
 
            
 
3315
 
2360
3316
            del _interface
2361
 
        
2362
 
        class MandosDBusServiceTransitional(MandosDBusService):
2363
 
            __metaclass__ = AlternateDBusNamesMetaclass
2364
 
        mandos_dbus_service = MandosDBusServiceTransitional()
2365
 
    
 
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
 
2366
3361
    def cleanup():
2367
3362
        "Cleanup function; run on exit"
2368
 
        service.cleanup()
2369
 
        
2370
 
        multiprocessing.active_children()
 
3363
        if zeroconf:
 
3364
            service.cleanup()
 
3365
 
 
3366
        mp.active_children()
 
3367
        wn.close()
2371
3368
        if not (tcp_server.clients or client_settings):
2372
3369
            return
2373
 
        
 
3370
 
2374
3371
        # Store client before exiting. Secrets are encrypted with key
2375
3372
        # based on what config file has. If config file is
2376
3373
        # removed/edited, old secret will thus be unrecovable.
2377
3374
        clients = {}
2378
3375
        with PGPEngine() as pgp:
2379
 
            for client in tcp_server.clients.itervalues():
 
3376
            for client in tcp_server.clients.values():
2380
3377
                key = client_settings[client.name]["secret"]
2381
3378
                client.encrypted_secret = pgp.encrypt(client.secret,
2382
3379
                                                      key)
2383
3380
                client_dict = {}
2384
 
                
 
3381
 
2385
3382
                # A list of attributes that can not be pickled
2386
3383
                # + secret.
2387
 
                exclude = set(("bus", "changedstate", "secret",
2388
 
                               "checker"))
2389
 
                for name, typ in (inspect.getmembers
2390
 
                                  (dbus.service.Object)):
 
3384
                exclude = {"bus", "changedstate", "secret",
 
3385
                           "checker", "server_settings"}
 
3386
                for name, typ in inspect.getmembers(dbus.service
 
3387
                                                    .Object):
2391
3388
                    exclude.add(name)
2392
 
                
 
3389
 
2393
3390
                client_dict["encrypted_secret"] = (client
2394
3391
                                                   .encrypted_secret)
2395
3392
                for attr in client.client_structure:
2396
3393
                    if attr not in exclude:
2397
3394
                        client_dict[attr] = getattr(client, attr)
2398
 
                
 
3395
 
2399
3396
                clients[client.name] = client_dict
2400
3397
                del client_settings[client.name]["secret"]
2401
 
        
 
3398
 
2402
3399
        try:
2403
 
            with os.fdopen(os.open(stored_state_path,
2404
 
                                   os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2405
 
                                   0600), "wb") as stored_state:
2406
 
                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
 
3409
            os.rename(tempname, stored_state_path)
2407
3410
        except (IOError, OSError) as e:
2408
 
            logger.warning("Could not save persistent state: {0}"
2409
 
                           .format(e))
2410
 
            if e.errno not in (errno.ENOENT, errno.EACCES):
 
3411
            if not debug:
 
3412
                try:
 
3413
                    os.remove(tempname)
 
3414
                except NameError:
 
3415
                    pass
 
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)
2411
3422
                raise
2412
 
        
 
3423
 
2413
3424
        # Delete all clients, and settings from config
2414
3425
        while tcp_server.clients:
2415
3426
            name, client = tcp_server.clients.popitem()
2416
3427
            if use_dbus:
2417
3428
                client.remove_from_connection()
2418
 
            # Don't signal anything except ClientRemoved
 
3429
            # Don't signal the disabling
2419
3430
            client.disable(quiet=True)
 
3431
            # Emit D-Bus signal for removal
2420
3432
            if use_dbus:
2421
 
                # Emit D-Bus signal
2422
 
                mandos_dbus_service.ClientRemoved(client
2423
 
                                                  .dbus_object_path,
2424
 
                                                  client.name)
 
3433
                mandos_dbus_service.client_removed_signal(client)
2425
3434
        client_settings.clear()
2426
 
    
 
3435
 
2427
3436
    atexit.register(cleanup)
2428
 
    
2429
 
    for client in tcp_server.clients.itervalues():
 
3437
 
 
3438
    for client in tcp_server.clients.values():
2430
3439
        if use_dbus:
2431
 
            # Emit D-Bus signal
2432
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3440
            # Emit D-Bus signal for adding
 
3441
            mandos_dbus_service.client_added_signal(client)
2433
3442
        # Need to initiate checking of clients
2434
3443
        if client.enabled:
2435
3444
            client.init_checker()
2436
 
    
 
3445
 
2437
3446
    tcp_server.enable()
2438
3447
    tcp_server.server_activate()
2439
 
    
 
3448
 
2440
3449
    # Find out what port we got
2441
 
    service.port = tcp_server.socket.getsockname()[1]
 
3450
    if zeroconf:
 
3451
        service.port = tcp_server.socket.getsockname()[1]
2442
3452
    if use_ipv6:
2443
3453
        logger.info("Now listening on address %r, port %d,"
2444
 
                    " flowinfo %d, scope_id %d"
2445
 
                    % tcp_server.socket.getsockname())
 
3454
                    " flowinfo %d, scope_id %d",
 
3455
                    *tcp_server.socket.getsockname())
2446
3456
    else:                       # IPv4
2447
 
        logger.info("Now listening on address %r, port %d"
2448
 
                    % tcp_server.socket.getsockname())
2449
 
    
2450
 
    #service.interface = tcp_server.socket.getsockname()[3]
2451
 
    
 
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
 
2452
3462
    try:
2453
 
        # From the Avahi example code
2454
 
        try:
2455
 
            service.activate()
2456
 
        except dbus.exceptions.DBusException as error:
2457
 
            logger.critical("DBusException: %s", error)
2458
 
            cleanup()
2459
 
            sys.exit(1)
2460
 
        # End of Avahi example code
2461
 
        
2462
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2463
 
                             lambda *args, **kwargs:
2464
 
                             (tcp_server.handle_request
2465
 
                              (*args[2:], **kwargs) or True))
2466
 
        
 
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
 
2467
3478
        logger.debug("Starting main loop")
2468
3479
        main_loop.run()
2469
3480
    except AvahiError as error:
2470
 
        logger.critical("AvahiError: %s", error)
 
3481
        logger.critical("Avahi Error", exc_info=error)
2471
3482
        cleanup()
2472
3483
        sys.exit(1)
2473
3484
    except KeyboardInterrupt:
2478
3489
    # Must run before the D-Bus bus name gets deregistered
2479
3490
    cleanup()
2480
3491
 
 
3492
 
2481
3493
if __name__ == '__main__':
2482
3494
    main()