/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-08-05 21:14:05 UTC
  • Revision ID: teddy@recompile.se-20190805211405-9m6hecekaihpttz9
Override lintian warnings about upgrading from old versions

There are some really things which are imperative that we fix in case
someone were to upgrade from a really old version.  We want to keep
these fixes in the postinst maintainer scripts, even though lintian
complains about such old upgrades not being supported by Debian in
general.  We prefer the code being there, for the sake of the users.

* debian/mandos-client.lintian-overrides
  (maintainer-script-supports-ancient-package-version): New.
  debian/mandos.lintian-overrides
  (maintainer-script-supports-ancient-package-version): - '' -

Show diffs side-by-side

added added

removed removed

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