/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-04-09 22:31:23 UTC
  • Revision ID: teddy@recompile.se-20190409223123-wjj0jw08p09kzd4w
Debian package: Fix backports package dependency adjuster

* debian/rules (override_dh_shlibdeps-arch): Add "--in-place" to "sed"
                                             options.

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