/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: 2011-11-29 20:30:21 UTC
  • mto: (518.1.13 mandos-persistent)
  • mto: This revision was merged to the branch mainline in revision 524.
  • Revision ID: teddy@recompile.se-20111129203021-fzsq7sn15wysgqhd
* mandos (ClientDBus.approval_delay, ClientDBus.approval_duration,
  ClientDBus.timeout, ClientDBus.extended_timeout,
  ClientDBus.interval): Bug fix: Cast to correct D-Bus type.
* mandos-ctl (string_to_delta): Interpret unadorned numbers as
                                milliseconds.

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-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
 
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
21
19
# the Free Software Foundation, either version 3 of the License, or
22
20
# (at your option) any later version.
23
21
#
24
 
#     Mandos is distributed in the hope that it will be useful, but
25
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
22
#     This program is distributed in the hope that it will be useful,
 
23
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
26
24
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27
25
#     GNU General Public License for more details.
28
 
#
 
26
29
27
# You should have received a copy of the GNU General Public License
30
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
31
 
#
 
28
# along with this program.  If not, see
 
29
# <http://www.gnu.org/licenses/>.
 
30
32
31
# Contact the authors at <mandos@recompile.se>.
33
 
#
 
32
34
33
 
35
34
from __future__ import (division, absolute_import, print_function,
36
35
                        unicode_literals)
37
36
 
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
 
37
import SocketServer as socketserver
47
38
import socket
48
39
import argparse
49
40
import datetime
50
41
import errno
51
 
try:
52
 
    import ConfigParser as configparser
53
 
except ImportError:
54
 
    import configparser
 
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
55
49
import sys
56
50
import re
57
51
import os
66
60
import struct
67
61
import fcntl
68
62
import functools
69
 
try:
70
 
    import cPickle as pickle
71
 
except ImportError:
72
 
    import pickle
 
63
import cPickle as pickle
73
64
import multiprocessing
74
65
import types
75
66
import binascii
76
67
import tempfile
77
 
import itertools
78
 
import collections
79
 
import codecs
80
68
 
81
69
import dbus
82
70
import dbus.service
83
 
from gi.repository import GLib
 
71
import gobject
 
72
import avahi
84
73
from dbus.mainloop.glib import DBusGMainLoop
85
74
import ctypes
86
75
import ctypes.util
87
76
import xml.dom.minidom
88
77
import inspect
 
78
import GnuPGInterface
89
79
 
90
 
# Try to find the value of SO_BINDTODEVICE:
91
80
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:
94
81
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
95
82
except AttributeError:
96
83
    try:
97
 
        # This is where SO_BINDTODEVICE was up to and including Python
98
 
        # 2.6, and also 3.2:
99
84
        from IN import SO_BINDTODEVICE
100
85
    except ImportError:
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.3"
 
86
        SO_BINDTODEVICE = None
 
87
 
 
88
 
 
89
version = "1.4.1"
119
90
stored_state_file = "clients.pickle"
120
91
 
121
92
logger = logging.getLogger()
122
 
syslogger = None
 
93
syslogger = (logging.handlers.SysLogHandler
 
94
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
95
              address = str("/dev/log")))
123
96
 
124
97
try:
125
 
    if_nametoindex = ctypes.cdll.LoadLibrary(
126
 
        ctypes.util.find_library("c")).if_nametoindex
 
98
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
99
                      (ctypes.util.find_library("c"))
 
100
                      .if_nametoindex)
127
101
except (OSError, AttributeError):
128
 
 
129
102
    def if_nametoindex(interface):
130
103
        "Get an interface index the hard way, i.e. using fcntl()"
131
104
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
132
105
        with contextlib.closing(socket.socket()) as s:
133
106
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
134
 
                                struct.pack(b"16s16x", interface))
135
 
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
107
                                struct.pack(str("16s16x"),
 
108
                                            interface))
 
109
        interface_index = struct.unpack(str("I"),
 
110
                                        ifreq[16:20])[0]
136
111
        return interface_index
137
112
 
138
113
 
139
 
def copy_function(func):
140
 
    """Make a copy of a function"""
141
 
    if sys.version_info.major == 2:
142
 
        return types.FunctionType(func.func_code,
143
 
                                  func.func_globals,
144
 
                                  func.func_name,
145
 
                                  func.func_defaults,
146
 
                                  func.func_closure)
147
 
    else:
148
 
        return types.FunctionType(func.__code__,
149
 
                                  func.__globals__,
150
 
                                  func.__name__,
151
 
                                  func.__defaults__,
152
 
                                  func.__closure__)
153
 
 
154
 
 
155
 
def initlogger(debug, level=logging.WARNING):
 
114
def initlogger(level=logging.WARNING):
156
115
    """init logger and add loglevel"""
157
 
 
158
 
    global syslogger
159
 
    syslogger = (logging.handlers.SysLogHandler(
160
 
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
161
 
        address="/dev/log"))
 
116
    
162
117
    syslogger.setFormatter(logging.Formatter
163
118
                           ('Mandos [%(process)d]: %(levelname)s:'
164
119
                            ' %(message)s'))
165
120
    logger.addHandler(syslogger)
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)
 
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)
174
128
    logger.setLevel(level)
175
129
 
176
130
 
181
135
 
182
136
class PGPEngine(object):
183
137
    """A simple class for OpenPGP symmetric encryption & decryption"""
184
 
 
185
138
    def __init__(self):
 
139
        self.gnupg = GnuPGInterface.GnuPG()
186
140
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
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
 
 
 
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
    
206
147
    def __enter__(self):
207
148
        return self
208
 
 
209
 
    def __exit__(self, exc_type, exc_value, traceback):
 
149
    
 
150
    def __exit__ (self, exc_type, exc_value, traceback):
210
151
        self._cleanup()
211
152
        return False
212
 
 
 
153
    
213
154
    def __del__(self):
214
155
        self._cleanup()
215
 
 
 
156
    
216
157
    def _cleanup(self):
217
158
        if self.tempdir is not None:
218
159
            # Delete contents of tempdir
219
160
            for root, dirs, files in os.walk(self.tempdir,
220
 
                                             topdown=False):
 
161
                                             topdown = False):
221
162
                for filename in files:
222
163
                    os.remove(os.path.join(root, filename))
223
164
                for dirname in dirs:
225
166
            # Remove tempdir
226
167
            os.rmdir(self.tempdir)
227
168
            self.tempdir = None
228
 
 
 
169
    
229
170
    def password_encode(self, password):
230
171
        # Passphrase can not be empty and can not contain newlines or
231
172
        # NUL bytes.  So we prefix it and hex encode it.
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
 
 
 
173
        return b"mandos" + binascii.hexlify(password)
 
174
    
240
175
    def encrypt(self, data, password):
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)
 
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
256
190
        return ciphertext
257
 
 
 
191
    
258
192
    def decrypt(self, data, password):
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)
 
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
274
207
        return decrypted_plaintext
275
208
 
276
209
 
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
 
 
302
210
 
303
211
class AvahiError(Exception):
304
212
    def __init__(self, value, *args, **kwargs):
305
213
        self.value = value
306
 
        return super(AvahiError, self).__init__(value, *args,
307
 
                                                **kwargs)
308
 
 
 
214
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
215
    def __unicode__(self):
 
216
        return unicode(repr(self.value))
309
217
 
310
218
class AvahiServiceError(AvahiError):
311
219
    pass
312
220
 
313
 
 
314
221
class AvahiGroupError(AvahiError):
315
222
    pass
316
223
 
317
224
 
318
225
class AvahiService(object):
319
226
    """An Avahi (Zeroconf) service.
320
 
 
 
227
    
321
228
    Attributes:
322
229
    interface: integer; avahi.IF_UNSPEC or an interface index.
323
230
               Used to optionally bind to the specified interface.
324
231
    name: string; Example: 'Mandos'
325
232
    type: string; Example: '_mandos._tcp'.
326
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
233
                  See <http://www.dns-sd.org/ServiceTypes.html>
327
234
    port: integer; what port to announce
328
235
    TXT: list of strings; TXT record for the service
329
236
    domain: string; Domain to publish on, default to .local if empty.
335
242
    server: D-Bus Server
336
243
    bus: dbus.SystemBus()
337
244
    """
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):
 
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):
350
249
        self.interface = interface
351
250
        self.name = name
352
251
        self.type = servicetype
361
260
        self.server = None
362
261
        self.bus = bus
363
262
        self.entry_group_state_changed_match = None
364
 
 
365
 
    def rename(self, remove=True):
 
263
    def rename(self):
366
264
        """Derived from the Avahi example code"""
367
265
        if self.rename_count >= self.max_renames:
368
266
            logger.critical("No suitable Zeroconf service name found"
369
267
                            " after %i retries, exiting.",
370
268
                            self.rename_count)
371
269
            raise AvahiServiceError("Too many renames")
372
 
        self.name = str(
373
 
            self.server.GetAlternativeServiceName(self.name))
374
 
        self.rename_count += 1
 
270
        self.name = unicode(self.server
 
271
                            .GetAlternativeServiceName(self.name))
375
272
        logger.info("Changing Zeroconf service name to %r ...",
376
273
                    self.name)
377
 
        if remove:
378
 
            self.remove()
 
274
        self.remove()
379
275
        try:
380
276
            self.add()
381
277
        except dbus.exceptions.DBusException as error:
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
 
 
 
278
            logger.critical("DBusException: %s", error)
 
279
            self.cleanup()
 
280
            os._exit(1)
 
281
        self.rename_count += 1
391
282
    def remove(self):
392
283
        """Derived from the Avahi example code"""
393
284
        if self.entry_group_state_changed_match is not None:
395
286
            self.entry_group_state_changed_match = None
396
287
        if self.group is not None:
397
288
            self.group.Reset()
398
 
 
399
289
    def add(self):
400
290
        """Derived from the Avahi example code"""
401
291
        self.remove()
418
308
            dbus.UInt16(self.port),
419
309
            avahi.string_array_to_txt_array(self.TXT))
420
310
        self.group.Commit()
421
 
 
422
311
    def entry_group_state_changed(self, state, error):
423
312
        """Derived from the Avahi example code"""
424
313
        logger.debug("Avahi entry group state change: %i", state)
425
 
 
 
314
        
426
315
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
427
316
            logger.debug("Zeroconf service established.")
428
317
        elif state == avahi.ENTRY_GROUP_COLLISION:
430
319
            self.rename()
431
320
        elif state == avahi.ENTRY_GROUP_FAILURE:
432
321
            logger.critical("Avahi: Error in group state changed %s",
433
 
                            str(error))
434
 
            raise AvahiGroupError("State changed: {!s}".format(error))
435
 
 
 
322
                            unicode(error))
 
323
            raise AvahiGroupError("State changed: %s"
 
324
                                  % unicode(error))
436
325
    def cleanup(self):
437
326
        """Derived from the Avahi example code"""
438
327
        if self.group is not None:
443
332
                pass
444
333
            self.group = None
445
334
        self.remove()
446
 
 
447
335
    def server_state_changed(self, state, error=None):
448
336
        """Derived from the Avahi example code"""
449
337
        logger.debug("Avahi server state change: %i", state)
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
 
        }
 
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" }
456
345
        if state in bad_states:
457
346
            if bad_states[state] is not None:
458
347
                if error is None:
461
350
                    logger.error(bad_states[state] + ": %r", error)
462
351
            self.cleanup()
463
352
        elif state == avahi.SERVER_RUNNING:
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)
 
353
            self.add()
476
354
        else:
477
355
            if error is None:
478
356
                logger.debug("Unknown state: %r", state)
479
357
            else:
480
358
                logger.debug("Unknown state: %r: %r", state, error)
481
 
 
482
359
    def activate(self):
483
360
        """Derived from the Avahi example code"""
484
361
        if self.server is None:
488
365
                                    follow_name_owner_changes=True),
489
366
                avahi.DBUS_INTERFACE_SERVER)
490
367
        self.server.connect_to_signal("StateChanged",
491
 
                                      self.server_state_changed)
 
368
                                 self.server_state_changed)
492
369
        self.server_state_changed(self.server.GetState())
493
370
 
494
 
 
495
371
class AvahiServiceToSyslog(AvahiService):
496
 
    def rename(self, *args, **kwargs):
 
372
    def rename(self):
497
373
        """Add the new name to the syslog messages"""
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)))
 
374
        ret = AvahiService.rename(self)
 
375
        syslogger.setFormatter(logging.Formatter
 
376
                               ('Mandos (%s) [%%(process)d]:'
 
377
                                ' %%(levelname)s: %%(message)s'
 
378
                                % self.name))
502
379
        return ret
503
380
 
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
 
 
 
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
        
817
387
class Client(object):
818
388
    """A representation of a client host served by this server.
819
 
 
 
389
    
820
390
    Attributes:
821
391
    approved:   bool(); 'None' if not yet approved/disapproved
822
392
    approval_delay: datetime.timedelta(); Time to wait for approval
824
394
    checker:    subprocess.Popen(); a running checker process used
825
395
                                    to see if the client lives.
826
396
                                    'None' if no process is running.
827
 
    checker_callback_tag: a GLib event source tag, or None
 
397
    checker_callback_tag: a gobject event source tag, or None
828
398
    checker_command: string; External command which is run to check
829
399
                     if client lives.  %() expansions are done at
830
400
                     runtime with vars(self) as dict, so that for
831
401
                     instance %(name)s can be used in the command.
832
 
    checker_initiator_tag: a GLib event source tag, or None
 
402
    checker_initiator_tag: a gobject event source tag, or None
833
403
    created:    datetime.datetime(); (UTC) object creation
834
404
    client_structure: Object describing what attributes a client has
835
405
                      and is used for storing the client at exit
836
406
    current_checker_command: string; current running checker_command
837
 
    disable_initiator_tag: a GLib event source tag, or None
 
407
    disable_initiator_tag: a gobject event source tag, or None
838
408
    enabled:    bool()
839
409
    fingerprint: string (40 or 32 hexadecimal digits); used to
840
 
                 uniquely identify an OpenPGP client
841
 
    key_id: string (64 hexadecimal digits); used to uniquely identify
842
 
            a client using raw public keys
 
410
                 uniquely identify the client
843
411
    host:       string; available for use by the checker command
844
412
    interval:   datetime.timedelta(); How often to start a new checker
845
413
    last_approval_request: datetime.datetime(); (UTC) or None
846
414
    last_checked_ok: datetime.datetime(); (UTC) or None
 
415
 
847
416
    last_checker_status: integer between 0 and 255 reflecting exit
848
417
                         status of last checker. -1 reflects crashed
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
 
418
                         checker, or None.
852
419
    last_enabled: datetime.datetime(); (UTC) or None
853
420
    name:       string; from the config file, used in log messages and
854
421
                        D-Bus identifiers
855
422
    secret:     bytestring; sent verbatim (over TLS) to client
856
423
    timeout:    datetime.timedelta(); How long from last_checked_ok
857
424
                                      until this client is disabled
858
 
    extended_timeout:   extra long timeout when secret has been sent
 
425
    extended_timeout:   extra long timeout when password has been sent
859
426
    runtime_expansions: Allowed attributes for runtime expansion.
860
427
    expires:    datetime.datetime(); time (UTC) when a client will be
861
428
                disabled, or None
862
 
    server_settings: The server_settings dict from main()
863
429
    """
864
 
 
 
430
    
865
431
    runtime_expansions = ("approval_delay", "approval_duration",
866
 
                          "created", "enabled", "expires", "key_id",
867
 
                          "fingerprint", "host", "interval",
868
 
                          "last_approval_request", "last_checked_ok",
 
432
                          "created", "enabled", "fingerprint",
 
433
                          "host", "interval", "last_checked_ok",
869
434
                          "last_enabled", "name", "timeout")
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):
 
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."""
937
455
        self.name = name
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
 
 
 
456
        if config is None:
 
457
            config = {}
955
458
        logger.debug("Creating client %r", self.name)
956
 
        logger.debug("  Key ID: %s", self.key_id)
 
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(" ", ""))
957
464
        logger.debug("  Fingerprint: %s", self.fingerprint)
958
 
        self.created = settings.get("created",
959
 
                                    datetime.datetime.utcnow())
960
 
 
961
 
        # attributes specific for this server instance
 
465
        if "secret" in config:
 
466
            self.secret = config["secret"].decode("base64")
 
467
        elif "secfile" in config:
 
468
            with open(os.path.expanduser(os.path.expandvars
 
469
                                         (config["secfile"])),
 
470
                      "rb") as secfile:
 
471
                self.secret = secfile.read()
 
472
        else:
 
473
            raise TypeError("No secret or secfile for client %s"
 
474
                            % self.name)
 
475
        self.host = config.get("host", "")
 
476
        self.created = datetime.datetime.utcnow()
 
477
        self.enabled = config.get("enabled", True)
 
478
        self.last_approval_request = None
 
479
        if self.enabled:
 
480
            self.last_enabled = datetime.datetime.utcnow()
 
481
        else:
 
482
            self.last_enabled = None
 
483
        self.last_checked_ok = None
 
484
        self.last_checker_status = None
 
485
        self.timeout = string_to_delta(config["timeout"])
 
486
        self.extended_timeout = string_to_delta(config
 
487
                                                ["extended_timeout"])
 
488
        self.interval = string_to_delta(config["interval"])
962
489
        self.checker = None
963
490
        self.checker_initiator_tag = None
964
491
        self.disable_initiator_tag = None
 
492
        if self.enabled:
 
493
            self.expires = datetime.datetime.utcnow() + self.timeout
 
494
        else:
 
495
            self.expires = None
965
496
        self.checker_callback_tag = None
 
497
        self.checker_command = config["checker"]
966
498
        self.current_checker_command = None
967
499
        self.approved = None
 
500
        self.approved_by_default = config.get("approved_by_default",
 
501
                                              True)
968
502
        self.approvals_pending = 0
969
 
        self.changedstate = multiprocessing_manager.Condition(
970
 
            multiprocessing_manager.Lock())
971
 
        self.client_structure = [attr
972
 
                                 for attr in self.__dict__.keys()
 
503
        self.approval_delay = string_to_delta(
 
504
            config["approval_delay"])
 
505
        self.approval_duration = string_to_delta(
 
506
            config["approval_duration"])
 
507
        self.changedstate = (multiprocessing_manager
 
508
                             .Condition(multiprocessing_manager
 
509
                                        .Lock()))
 
510
        self.client_structure = [attr for attr in
 
511
                                 self.__dict__.iterkeys()
973
512
                                 if not attr.startswith("_")]
974
513
        self.client_structure.append("client_structure")
975
 
 
976
 
        for name, t in inspect.getmembers(
977
 
                type(self), lambda obj: isinstance(obj, property)):
 
514
        
 
515
        for name, t in inspect.getmembers(type(self),
 
516
                                          lambda obj:
 
517
                                              isinstance(obj,
 
518
                                                         property)):
978
519
            if not name.startswith("_"):
979
520
                self.client_structure.append(name)
980
 
 
 
521
    
981
522
    # Send notice to process children that client state has changed
982
523
    def send_changedstate(self):
983
524
        with self.changedstate:
984
525
            self.changedstate.notify_all()
985
 
 
 
526
    
986
527
    def enable(self):
987
528
        """Start this client's checker and timeout hooks"""
988
529
        if getattr(self, "enabled", False):
989
530
            # Already enabled
990
531
            return
 
532
        self.send_changedstate()
991
533
        self.expires = datetime.datetime.utcnow() + self.timeout
992
534
        self.enabled = True
993
535
        self.last_enabled = datetime.datetime.utcnow()
994
536
        self.init_checker()
995
 
        self.send_changedstate()
996
 
 
 
537
    
997
538
    def disable(self, quiet=True):
998
539
        """Disable this client."""
999
540
        if not getattr(self, "enabled", False):
1000
541
            return False
1001
542
        if not quiet:
 
543
            self.send_changedstate()
 
544
        if not quiet:
1002
545
            logger.info("Disabling client %s", self.name)
1003
 
        if getattr(self, "disable_initiator_tag", None) is not None:
1004
 
            GLib.source_remove(self.disable_initiator_tag)
 
546
        if getattr(self, "disable_initiator_tag", False):
 
547
            gobject.source_remove(self.disable_initiator_tag)
1005
548
            self.disable_initiator_tag = None
1006
549
        self.expires = None
1007
 
        if getattr(self, "checker_initiator_tag", None) is not None:
1008
 
            GLib.source_remove(self.checker_initiator_tag)
 
550
        if getattr(self, "checker_initiator_tag", False):
 
551
            gobject.source_remove(self.checker_initiator_tag)
1009
552
            self.checker_initiator_tag = None
1010
553
        self.stop_checker()
1011
554
        self.enabled = False
1012
 
        if not quiet:
1013
 
            self.send_changedstate()
1014
 
        # Do not run this again if called by a GLib.timeout_add
 
555
        # Do not run this again if called by a gobject.timeout_add
1015
556
        return False
1016
 
 
 
557
    
1017
558
    def __del__(self):
1018
559
        self.disable()
1019
 
 
 
560
    
1020
561
    def init_checker(self):
1021
562
        # Schedule a new checker to be started an 'interval' from now,
1022
563
        # and every interval from then on.
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)
 
564
        self.checker_initiator_tag = (gobject.timeout_add
 
565
                                      (self.interval_milliseconds(),
 
566
                                       self.start_checker))
1028
567
        # Schedule a disable() when 'timeout' has passed
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)
 
568
        self.disable_initiator_tag = (gobject.timeout_add
 
569
                                   (self.timeout_milliseconds(),
 
570
                                    self.disable))
1033
571
        # Also start a new checker *right now*.
1034
572
        self.start_checker()
1035
 
 
1036
 
    def checker_callback(self, source, condition, connection,
1037
 
                         command):
 
573
    
 
574
    def checker_callback(self, pid, condition, command):
1038
575
        """The checker has completed, so take appropriate actions."""
1039
576
        self.checker_callback_tag = None
1040
577
        self.checker = None
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
 
578
        if os.WIFEXITED(condition):
 
579
            self.last_checker_status = os.WEXITSTATUS(condition)
1048
580
            if self.last_checker_status == 0:
1049
581
                logger.info("Checker for %(name)s succeeded",
1050
582
                            vars(self))
1051
583
                self.checked_ok()
1052
584
            else:
1053
 
                logger.info("Checker for %(name)s failed", vars(self))
 
585
                logger.info("Checker for %(name)s failed",
 
586
                            vars(self))
1054
587
        else:
1055
588
            self.last_checker_status = -1
1056
 
            self.last_checker_signal = -returncode
1057
589
            logger.warning("Checker for %(name)s crashed?",
1058
590
                           vars(self))
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."""
 
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
        """
1070
598
        if timeout is None:
1071
599
            timeout = self.timeout
 
600
        self.last_checked_ok = datetime.datetime.utcnow()
1072
601
        if self.disable_initiator_tag is not None:
1073
 
            GLib.source_remove(self.disable_initiator_tag)
1074
 
            self.disable_initiator_tag = None
 
602
            gobject.source_remove(self.disable_initiator_tag)
1075
603
        if getattr(self, "enabled", False):
1076
 
            self.disable_initiator_tag = GLib.timeout_add(
1077
 
                int(timeout.total_seconds() * 1000), self.disable)
 
604
            self.disable_initiator_tag = (gobject.timeout_add
 
605
                                          (timedelta_to_milliseconds
 
606
                                           (timeout), self.disable))
1078
607
            self.expires = datetime.datetime.utcnow() + timeout
1079
 
 
 
608
    
1080
609
    def need_approval(self):
1081
610
        self.last_approval_request = datetime.datetime.utcnow()
1082
 
 
 
611
    
1083
612
    def start_checker(self):
1084
613
        """Start a new checker subprocess if one is not running.
1085
 
 
 
614
        
1086
615
        If a checker already exists, leave it running and do
1087
616
        nothing."""
1088
617
        # The reason for not killing a running checker is that if we
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
 
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
1093
622
        # checkers alone, the checker would have to take more time
1094
623
        # than 'timeout' for the client to be disabled, which is as it
1095
624
        # should be.
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
 
625
        
 
626
        # If a checker exists, make sure it is not a zombie
 
627
        try:
 
628
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
629
        except (AttributeError, OSError) as error:
 
630
            if (isinstance(error, OSError)
 
631
                and error.errno != errno.ECHILD):
 
632
                raise error
 
633
        else:
 
634
            if pid:
 
635
                logger.warning("Checker was a zombie")
 
636
                gobject.source_remove(self.checker_callback_tag)
 
637
                self.checker_callback(pid, status,
 
638
                                      self.current_checker_command)
1101
639
        # Start a new checker if needed
1102
640
        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}
1107
641
            try:
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
 
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
1114
660
            self.current_checker_command = command
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
 
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
1141
685
        return True
1142
 
 
 
686
    
1143
687
    def stop_checker(self):
1144
688
        """Force the checker process, if any, to stop."""
1145
689
        if self.checker_callback_tag:
1146
 
            GLib.source_remove(self.checker_callback_tag)
 
690
            gobject.source_remove(self.checker_callback_tag)
1147
691
            self.checker_callback_tag = None
1148
692
        if getattr(self, "checker", None) is None:
1149
693
            return
1150
694
        logger.debug("Stopping checker for %(name)s", vars(self))
1151
 
        self.checker.terminate()
 
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
1152
703
        self.checker = None
1153
704
 
1154
705
 
1155
 
def dbus_service_property(dbus_interface,
1156
 
                          signature="v",
1157
 
                          access="readwrite",
1158
 
                          byte_arrays=False):
 
706
def dbus_service_property(dbus_interface, signature="v",
 
707
                          access="readwrite", byte_arrays=False):
1159
708
    """Decorators for marking methods of a DBusObjectWithProperties to
1160
709
    become properties on the D-Bus.
1161
 
 
 
710
    
1162
711
    The decorated method will be called with no arguments by "Get"
1163
712
    and with one argument by "Set".
1164
 
 
 
713
    
1165
714
    The parameters, where they are supported, are the same as
1166
715
    dbus.service.method, except there is only "signature", since the
1167
716
    type from Get() and the type sent to Set() is the same.
1170
719
    # "Set" method, so we fail early here:
1171
720
    if byte_arrays and signature != "ay":
1172
721
        raise ValueError("Byte arrays not supported for non-'ay'"
1173
 
                         " signature {!r}".format(signature))
1174
 
 
 
722
                         " signature %r" % signature)
1175
723
    def decorator(func):
1176
724
        func._dbus_is_property = True
1177
725
        func._dbus_interface = dbus_interface
1180
728
        func._dbus_name = func.__name__
1181
729
        if func._dbus_name.endswith("_dbus_property"):
1182
730
            func._dbus_name = func._dbus_name[:-14]
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
 
 
 
731
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
732
        return func
1229
733
    return decorator
1230
734
 
1231
735
 
1232
736
class DBusPropertyException(dbus.exceptions.DBusException):
1233
737
    """A base class for D-Bus property-related exceptions
1234
738
    """
1235
 
    pass
 
739
    def __unicode__(self):
 
740
        return unicode(str(self))
1236
741
 
1237
742
 
1238
743
class DBusPropertyAccessException(DBusPropertyException):
1247
752
    pass
1248
753
 
1249
754
 
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):
 
755
class DBusObjectWithProperties(dbus.service.Object):
1340
756
    """A D-Bus object with properties.
1341
 
 
 
757
    
1342
758
    Classes inheriting from this can use the dbus_service_property
1343
759
    decorator to expose methods as D-Bus properties.  It exposes the
1344
760
    standard Get(), Set(), and GetAll() methods on the D-Bus.
1345
761
    """
1346
 
 
 
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
    
1347
775
    def _get_dbus_property(self, interface_name, property_name):
1348
776
        """Returns a bound method if one exists which is a D-Bus
1349
777
        property with the specified name and interface.
1350
778
        """
1351
 
        for cls in self.__class__.__mro__:
1352
 
            for name, value in inspect.getmembers(
1353
 
                    cls, self._is_dbus_thing("property")):
 
779
        for cls in  self.__class__.__mro__:
 
780
            for name, value in (inspect.getmembers
 
781
                                (cls, self._is_dbus_property)):
1354
782
                if (value._dbus_name == property_name
1355
783
                    and value._dbus_interface == interface_name):
1356
784
                    return value.__get__(self)
1357
 
 
 
785
        
1358
786
        # No such property
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",
 
787
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
788
                                   + interface_name + "."
 
789
                                   + property_name)
 
790
    
 
791
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1373
792
                         out_signature="v")
1374
793
    def Get(self, interface_name, property_name):
1375
794
        """Standard D-Bus property Get() method, see D-Bus standard.
1381
800
        if not hasattr(value, "variant_level"):
1382
801
            return value
1383
802
        return type(value)(value, variant_level=value.variant_level+1)
1384
 
 
 
803
    
1385
804
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1386
805
    def Set(self, interface_name, property_name, value):
1387
806
        """Standard D-Bus property Set() method, see D-Bus standard.
1393
812
            # The byte_arrays option is not supported yet on
1394
813
            # signatures other than "ay".
1395
814
            if prop._dbus_signature != "ay":
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))
 
815
                raise ValueError
 
816
            value = dbus.ByteArray(''.join(unichr(byte)
 
817
                                           for byte in value))
1401
818
        prop(value)
1402
 
 
1403
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1404
 
                         in_signature="s",
 
819
    
 
820
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1405
821
                         out_signature="a{sv}")
1406
822
    def GetAll(self, interface_name):
1407
823
        """Standard D-Bus property GetAll() method, see D-Bus
1408
824
        standard.
1409
 
 
 
825
        
1410
826
        Note: Will not include properties with access="write".
1411
827
        """
1412
828
        properties = {}
1413
 
        for name, prop in self._get_all_dbus_things("property"):
 
829
        for name, prop in self._get_all_dbus_properties():
1414
830
            if (interface_name
1415
831
                and interface_name != prop._dbus_interface):
1416
832
                # Interface non-empty but did not match
1422
838
            if not hasattr(value, "variant_level"):
1423
839
                properties[name] = value
1424
840
                continue
1425
 
            properties[name] = type(value)(
1426
 
                value, variant_level=value.variant_level + 1)
 
841
            properties[name] = type(value)(value, variant_level=
 
842
                                           value.variant_level+1)
1427
843
        return dbus.Dictionary(properties, signature="sv")
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
 
 
 
844
    
1437
845
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1438
846
                         out_signature="s",
1439
847
                         path_keyword='object_path',
1440
848
                         connection_keyword='connection')
1441
849
    def Introspect(self, object_path, connection):
1442
 
        """Overloading of standard D-Bus method.
1443
 
 
1444
 
        Inserts property tags and interface annotation tags.
 
850
        """Standard D-Bus method, overloaded to insert property tags.
1445
851
        """
1446
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1447
 
                                                         object_path,
1448
 
                                                         connection)
 
852
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
853
                                                   connection)
1449
854
        try:
1450
855
            document = xml.dom.minidom.parseString(xmlstring)
1451
 
 
1452
856
            def make_tag(document, name, prop):
1453
857
                e = document.createElement("property")
1454
858
                e.setAttribute("name", name)
1455
859
                e.setAttribute("type", prop._dbus_signature)
1456
860
                e.setAttribute("access", prop._dbus_access)
1457
861
                return e
1458
 
 
1459
862
            for if_tag in document.getElementsByTagName("interface"):
1460
 
                # Add property tags
1461
863
                for tag in (make_tag(document, name, prop)
1462
864
                            for name, prop
1463
 
                            in self._get_all_dbus_things("property")
 
865
                            in self._get_all_dbus_properties()
1464
866
                            if prop._dbus_interface
1465
867
                            == if_tag.getAttribute("name")):
1466
868
                    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)
1483
869
                # Add the names to the return values for the
1484
870
                # "org.freedesktop.DBus.Properties" methods
1485
871
                if (if_tag.getAttribute("name")
1500
886
        except (AttributeError, xml.dom.DOMException,
1501
887
                xml.parsers.expat.ExpatError) as error:
1502
888
            logger.error("Failed to override Introspection method",
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):
 
889
                         error)
 
890
        return xmlstring
 
891
 
 
892
 
 
893
def datetime_to_dbus (dt, variant_level=0):
1579
894
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1580
895
    if dt is None:
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).
 
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.
1607
905
    """
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):
 
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):
1616
913
                # Ignore non-D-Bus attributes, and D-Bus attributes
1617
914
                # with the wrong interface name
1618
915
                if (not hasattr(attribute, "_dbus_interface")
1619
 
                    or not attribute._dbus_interface.startswith(
1620
 
                        orig_interface_name)):
 
916
                    or not attribute._dbus_interface
 
917
                    .startswith("se.recompile.Mandos")):
1621
918
                    continue
1622
919
                # Create an alternate D-Bus interface name based on
1623
920
                # the current name
1624
 
                alt_interface = attribute._dbus_interface.replace(
1625
 
                    orig_interface_name, alt_interface_name)
1626
 
                interface_names.add(alt_interface)
 
921
                alt_interface = (attribute._dbus_interface
 
922
                                 .replace("se.recompile.Mandos",
 
923
                                          "se.bsnet.fukt.Mandos"))
1627
924
                # Is this a D-Bus signal?
1628
925
                if getattr(attribute, "_dbus_is_signal", False):
1629
 
                    # Extract the original non-method undecorated
1630
 
                    # function by black magic
1631
 
                    if sys.version_info.major == 2:
1632
 
                        nonmethod_func = (dict(
 
926
                    # Extract the original non-method function by
 
927
                    # black magic
 
928
                    nonmethod_func = (dict(
1633
929
                            zip(attribute.func_code.co_freevars,
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)
 
930
                                attribute.__closure__))["func"]
 
931
                                      .cell_contents)
1641
932
                    # Create a new, but exactly alike, function
1642
933
                    # object, and decorate it to be a new D-Bus signal
1643
934
                    # with the alternate D-Bus interface name
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
 
 
 
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)))
1655
944
                    # Define a creator of a function to call both the
1656
 
                    # original and alternate functions, so both the
1657
 
                    # original and alternate signals gets sent when
1658
 
                    # the function is called
 
945
                    # old and new functions, so both the old and new
 
946
                    # signals gets sent when the function is called
1659
947
                    def fixscope(func1, func2):
1660
948
                        """This function is a scope container to pass
1661
949
                        func1 and func2 to the "call_both" function
1662
950
                        outside of its arguments"""
1663
 
 
1664
 
                        @functools.wraps(func2)
1665
951
                        def call_both(*args, **kwargs):
1666
952
                            """This function will emit two D-Bus
1667
953
                            signals by calling func1 and func2"""
1668
954
                            func1(*args, **kwargs)
1669
955
                            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
 
 
1676
956
                        return call_both
1677
957
                    # Create the "call_both" function and add it to
1678
958
                    # the class
1679
 
                    attr[attrname] = fixscope(attribute, new_function)
 
959
                    attr[attrname] = fixscope(attribute,
 
960
                                              new_function)
1680
961
                # Is this a D-Bus method?
1681
962
                elif getattr(attribute, "_dbus_is_method", False):
1682
963
                    # Create a new, but exactly alike, function
1683
964
                    # object.  Decorate it to be a new D-Bus method
1684
965
                    # with the alternate D-Bus interface name.  Add it
1685
966
                    # to the class.
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
 
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)))
1698
977
                # Is this a D-Bus property?
1699
978
                elif getattr(attribute, "_dbus_is_property", False):
1700
979
                    # Create a new, but exactly alike, function
1701
980
                    # object, and decorate it to be a new D-Bus
1702
981
                    # property with the alternate D-Bus interface
1703
982
                    # name.  Add it to the class.
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"})
 
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
 
1756
999
class ClientDBus(Client, DBusObjectWithProperties):
1757
1000
    """A Client class using D-Bus
1758
 
 
 
1001
    
1759
1002
    Attributes:
1760
1003
    dbus_object_path: dbus.ObjectPath
1761
1004
    bus: dbus.SystemBus()
1762
1005
    """
1763
 
 
 
1006
    
1764
1007
    runtime_expansions = (Client.runtime_expansions
1765
 
                          + ("dbus_object_path", ))
1766
 
 
1767
 
    _interface = "se.recompile.Mandos.Client"
1768
 
 
 
1008
                          + ("dbus_object_path",))
 
1009
    
1769
1010
    # dbus.service.Object doesn't use super(), so we can't either.
1770
 
 
1771
 
    def __init__(self, bus=None, *args, **kwargs):
 
1011
    
 
1012
    def __init__(self, bus = None, *args, **kwargs):
1772
1013
        self.bus = bus
1773
1014
        Client.__init__(self, *args, **kwargs)
 
1015
        
 
1016
        self._approvals_pending = 0
1774
1017
        # Only now, when this client is initialized, can it show up on
1775
1018
        # the D-Bus
1776
 
        client_object_name = str(self.name).translate(
 
1019
        client_object_name = unicode(self.name).translate(
1777
1020
            {ord("."): ord("_"),
1778
1021
             ord("-"): ord("_")})
1779
 
        self.dbus_object_path = dbus.ObjectPath(
1780
 
            "/clients/" + client_object_name)
 
1022
        self.dbus_object_path = (dbus.ObjectPath
 
1023
                                 ("/clients/" + client_object_name))
1781
1024
        DBusObjectWithProperties.__init__(self, self.bus,
1782
1025
                                          self.dbus_object_path)
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):
 
1026
        
 
1027
    def notifychangeproperty(transform_func,
 
1028
                             dbus_name, type_func=lambda x: x,
 
1029
                             variant_level=1):
1789
1030
        """ Modify a variable so that it's a property which announces
1790
1031
        its changes to DBus.
1791
 
 
 
1032
        
1792
1033
        transform_fun: Function that takes a value and a variant_level
1793
1034
                       and transforms it to a D-Bus type.
1794
1035
        dbus_name: D-Bus name of the variable
1796
1037
                   to the D-Bus.  Default: no transform
1797
1038
        variant_level: D-Bus variant level.  Default: 1
1798
1039
        """
1799
 
        attrname = "_{}".format(dbus_name)
1800
 
 
 
1040
        attrname = "_{0}".format(dbus_name)
1801
1041
        def setter(self, value):
1802
1042
            if hasattr(self, "dbus_object_path"):
1803
1043
                if (not hasattr(self, attrname) or
1804
1044
                    type_func(getattr(self, attrname, None))
1805
1045
                    != type_func(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())
 
1046
                    dbus_value = transform_func(type_func(value),
 
1047
                                                variant_level
 
1048
                                                =variant_level)
 
1049
                    self.PropertyChanged(dbus.String(dbus_name),
 
1050
                                         dbus_value)
1821
1051
            setattr(self, attrname, value)
1822
 
 
 
1052
        
1823
1053
        return property(lambda self: getattr(self, attrname), setter)
1824
 
 
 
1054
    
 
1055
    
1825
1056
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1826
1057
    approvals_pending = notifychangeproperty(dbus.Boolean,
1827
1058
                                             "ApprovalPending",
1828
 
                                             type_func=bool)
 
1059
                                             type_func = bool)
1829
1060
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1830
1061
    last_enabled = notifychangeproperty(datetime_to_dbus,
1831
1062
                                        "LastEnabled")
1832
 
    checker = notifychangeproperty(
1833
 
        dbus.Boolean, "CheckerRunning",
1834
 
        type_func=lambda checker: checker is not None)
 
1063
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1064
                                   type_func = lambda checker:
 
1065
                                       checker is not None)
1835
1066
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1836
1067
                                           "LastCheckedOK")
1837
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1838
 
                                               "LastCheckerStatus")
1839
1068
    last_approval_request = notifychangeproperty(
1840
1069
        datetime_to_dbus, "LastApprovalRequest")
1841
1070
    approved_by_default = notifychangeproperty(dbus.Boolean,
1842
1071
                                               "ApprovedByDefault")
1843
 
    approval_delay = notifychangeproperty(
1844
 
        dbus.UInt64, "ApprovalDelay",
1845
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1072
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1073
                                          "ApprovalDelay",
 
1074
                                          type_func =
 
1075
                                          timedelta_to_milliseconds)
1846
1076
    approval_duration = notifychangeproperty(
1847
1077
        dbus.UInt64, "ApprovalDuration",
1848
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1078
        type_func = timedelta_to_milliseconds)
1849
1079
    host = notifychangeproperty(dbus.String, "Host")
1850
 
    timeout = notifychangeproperty(
1851
 
        dbus.UInt64, "Timeout",
1852
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1080
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1081
                                   type_func =
 
1082
                                   timedelta_to_milliseconds)
1853
1083
    extended_timeout = notifychangeproperty(
1854
1084
        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)
 
1085
        type_func = timedelta_to_milliseconds)
 
1086
    interval = notifychangeproperty(dbus.UInt64,
 
1087
                                    "Interval",
 
1088
                                    type_func =
 
1089
                                    timedelta_to_milliseconds)
1859
1090
    checker_command = notifychangeproperty(dbus.String, "Checker")
1860
 
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1861
 
                                  invalidate_only=True)
1862
 
 
 
1091
    
1863
1092
    del notifychangeproperty
1864
 
 
 
1093
    
1865
1094
    def __del__(self, *args, **kwargs):
1866
1095
        try:
1867
1096
            self.remove_from_connection()
1870
1099
        if hasattr(DBusObjectWithProperties, "__del__"):
1871
1100
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1872
1101
        Client.__del__(self, *args, **kwargs)
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:
 
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)
1881
1109
            # Emit D-Bus signal
1882
1110
            self.CheckerCompleted(dbus.Int16(exitstatus),
1883
 
                                  # This is specific to GNU libC
1884
 
                                  dbus.Int64(exitstatus << 8),
 
1111
                                  dbus.Int64(condition),
1885
1112
                                  dbus.String(command))
1886
1113
        else:
1887
1114
            # Emit D-Bus signal
1888
1115
            self.CheckerCompleted(dbus.Int16(-1),
1889
 
                                  dbus.Int64(
1890
 
                                      # This is specific to GNU libC
1891
 
                                      (exitstatus << 8)
1892
 
                                      | self.last_checker_signal),
 
1116
                                  dbus.Int64(condition),
1893
1117
                                  dbus.String(command))
1894
 
        return ret
1895
 
 
 
1118
        
 
1119
        return Client.checker_callback(self, pid, condition, command,
 
1120
                                       *args, **kwargs)
 
1121
    
1896
1122
    def start_checker(self, *args, **kwargs):
1897
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
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
1898
1128
        r = Client.start_checker(self, *args, **kwargs)
1899
1129
        # Only if new checker process was started
1900
1130
        if (self.checker is not None
1902
1132
            # Emit D-Bus signal
1903
1133
            self.CheckerStarted(self.current_checker_command)
1904
1134
        return r
1905
 
 
 
1135
    
1906
1136
    def _reset_approved(self):
1907
1137
        self.approved = None
1908
1138
        return False
1909
 
 
 
1139
    
1910
1140
    def approve(self, value=True):
 
1141
        self.send_changedstate()
1911
1142
        self.approved = value
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
 
 
 
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
    
1922
1153
    # CheckerCompleted - signal
1923
1154
    @dbus.service.signal(_interface, signature="nxs")
1924
1155
    def CheckerCompleted(self, exitcode, waitstatus, command):
1925
1156
        "D-Bus signal"
1926
1157
        pass
1927
 
 
 
1158
    
1928
1159
    # CheckerStarted - signal
1929
1160
    @dbus.service.signal(_interface, signature="s")
1930
1161
    def CheckerStarted(self, command):
1931
1162
        "D-Bus signal"
1932
1163
        pass
1933
 
 
 
1164
    
1934
1165
    # PropertyChanged - signal
1935
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1936
1166
    @dbus.service.signal(_interface, signature="sv")
1937
1167
    def PropertyChanged(self, property, value):
1938
1168
        "D-Bus signal"
1939
1169
        pass
1940
 
 
 
1170
    
1941
1171
    # GotSecret - signal
1942
1172
    @dbus.service.signal(_interface)
1943
1173
    def GotSecret(self):
1946
1176
        server to mandos-client
1947
1177
        """
1948
1178
        pass
1949
 
 
 
1179
    
1950
1180
    # Rejected - signal
1951
1181
    @dbus.service.signal(_interface, signature="s")
1952
1182
    def Rejected(self, reason):
1953
1183
        "D-Bus signal"
1954
1184
        pass
1955
 
 
 
1185
    
1956
1186
    # NeedApproval - signal
1957
1187
    @dbus.service.signal(_interface, signature="tb")
1958
1188
    def NeedApproval(self, timeout, default):
1959
1189
        "D-Bus signal"
1960
1190
        return self.need_approval()
1961
 
 
1962
 
    #  Methods
1963
 
 
 
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
    
1964
1202
    # Approve - method
1965
1203
    @dbus.service.method(_interface, in_signature="b")
1966
1204
    def Approve(self, value):
1967
1205
        self.approve(value)
1968
 
 
 
1206
    
1969
1207
    # CheckedOK - method
1970
1208
    @dbus.service.method(_interface)
1971
1209
    def CheckedOK(self):
1972
1210
        self.checked_ok()
1973
 
 
 
1211
    
1974
1212
    # Enable - method
1975
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1976
1213
    @dbus.service.method(_interface)
1977
1214
    def Enable(self):
1978
1215
        "D-Bus method"
1979
1216
        self.enable()
1980
 
 
 
1217
    
1981
1218
    # StartChecker - method
1982
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1983
1219
    @dbus.service.method(_interface)
1984
1220
    def StartChecker(self):
1985
1221
        "D-Bus method"
1986
1222
        self.start_checker()
1987
 
 
 
1223
    
1988
1224
    # Disable - method
1989
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1990
1225
    @dbus.service.method(_interface)
1991
1226
    def Disable(self):
1992
1227
        "D-Bus method"
1993
1228
        self.disable()
1994
 
 
 
1229
    
1995
1230
    # StopChecker - method
1996
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
1231
    @dbus.service.method(_interface)
1998
1232
    def StopChecker(self):
1999
1233
        self.stop_checker()
2000
 
 
2001
 
    #  Properties
2002
 
 
 
1234
    
 
1235
    ## Properties
 
1236
    
2003
1237
    # ApprovalPending - property
2004
1238
    @dbus_service_property(_interface, signature="b", access="read")
2005
1239
    def ApprovalPending_dbus_property(self):
2006
1240
        return dbus.Boolean(bool(self.approvals_pending))
2007
 
 
 
1241
    
2008
1242
    # ApprovedByDefault - property
2009
 
    @dbus_service_property(_interface,
2010
 
                           signature="b",
 
1243
    @dbus_service_property(_interface, signature="b",
2011
1244
                           access="readwrite")
2012
1245
    def ApprovedByDefault_dbus_property(self, value=None):
2013
1246
        if value is None:       # get
2014
1247
            return dbus.Boolean(self.approved_by_default)
2015
1248
        self.approved_by_default = bool(value)
2016
 
 
 
1249
    
2017
1250
    # ApprovalDelay - property
2018
 
    @dbus_service_property(_interface,
2019
 
                           signature="t",
 
1251
    @dbus_service_property(_interface, signature="t",
2020
1252
                           access="readwrite")
2021
1253
    def ApprovalDelay_dbus_property(self, value=None):
2022
1254
        if value is None:       # get
2023
 
            return dbus.UInt64(self.approval_delay.total_seconds()
2024
 
                               * 1000)
 
1255
            return dbus.UInt64(self.approval_delay_milliseconds())
2025
1256
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
2026
 
 
 
1257
    
2027
1258
    # ApprovalDuration - property
2028
 
    @dbus_service_property(_interface,
2029
 
                           signature="t",
 
1259
    @dbus_service_property(_interface, signature="t",
2030
1260
                           access="readwrite")
2031
1261
    def ApprovalDuration_dbus_property(self, value=None):
2032
1262
        if value is None:       # get
2033
 
            return dbus.UInt64(self.approval_duration.total_seconds()
2034
 
                               * 1000)
 
1263
            return dbus.UInt64(timedelta_to_milliseconds(
 
1264
                    self.approval_duration))
2035
1265
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
2036
 
 
 
1266
    
2037
1267
    # Name - property
2038
 
    @dbus_annotations(
2039
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2040
1268
    @dbus_service_property(_interface, signature="s", access="read")
2041
1269
    def Name_dbus_property(self):
2042
1270
        return dbus.String(self.name)
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
 
 
 
1271
    
2051
1272
    # Fingerprint - property
2052
 
    @dbus_annotations(
2053
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2054
1273
    @dbus_service_property(_interface, signature="s", access="read")
2055
1274
    def Fingerprint_dbus_property(self):
2056
1275
        return dbus.String(self.fingerprint)
2057
 
 
 
1276
    
2058
1277
    # Host - property
2059
 
    @dbus_service_property(_interface,
2060
 
                           signature="s",
 
1278
    @dbus_service_property(_interface, signature="s",
2061
1279
                           access="readwrite")
2062
1280
    def Host_dbus_property(self, value=None):
2063
1281
        if value is None:       # get
2064
1282
            return dbus.String(self.host)
2065
 
        self.host = str(value)
2066
 
 
 
1283
        self.host = unicode(value)
 
1284
    
2067
1285
    # Created - property
2068
 
    @dbus_annotations(
2069
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
1286
    @dbus_service_property(_interface, signature="s", access="read")
2071
1287
    def Created_dbus_property(self):
2072
1288
        return datetime_to_dbus(self.created)
2073
 
 
 
1289
    
2074
1290
    # LastEnabled - property
2075
1291
    @dbus_service_property(_interface, signature="s", access="read")
2076
1292
    def LastEnabled_dbus_property(self):
2077
1293
        return datetime_to_dbus(self.last_enabled)
2078
 
 
 
1294
    
2079
1295
    # Enabled - property
2080
 
    @dbus_service_property(_interface,
2081
 
                           signature="b",
 
1296
    @dbus_service_property(_interface, signature="b",
2082
1297
                           access="readwrite")
2083
1298
    def Enabled_dbus_property(self, value=None):
2084
1299
        if value is None:       # get
2087
1302
            self.enable()
2088
1303
        else:
2089
1304
            self.disable()
2090
 
 
 
1305
    
2091
1306
    # LastCheckedOK - property
2092
 
    @dbus_service_property(_interface,
2093
 
                           signature="s",
 
1307
    @dbus_service_property(_interface, signature="s",
2094
1308
                           access="readwrite")
2095
1309
    def LastCheckedOK_dbus_property(self, value=None):
2096
1310
        if value is not None:
2097
1311
            self.checked_ok()
2098
1312
            return
2099
1313
        return datetime_to_dbus(self.last_checked_ok)
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
 
 
 
1314
    
2106
1315
    # Expires - property
2107
1316
    @dbus_service_property(_interface, signature="s", access="read")
2108
1317
    def Expires_dbus_property(self):
2109
1318
        return datetime_to_dbus(self.expires)
2110
 
 
 
1319
    
2111
1320
    # LastApprovalRequest - property
2112
1321
    @dbus_service_property(_interface, signature="s", access="read")
2113
1322
    def LastApprovalRequest_dbus_property(self):
2114
1323
        return datetime_to_dbus(self.last_approval_request)
2115
 
 
 
1324
    
2116
1325
    # Timeout - property
2117
 
    @dbus_service_property(_interface,
2118
 
                           signature="t",
 
1326
    @dbus_service_property(_interface, signature="t",
2119
1327
                           access="readwrite")
2120
1328
    def Timeout_dbus_property(self, value=None):
2121
1329
        if value is None:       # get
2122
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
2123
 
        old_timeout = self.timeout
 
1330
            return dbus.UInt64(self.timeout_milliseconds())
2124
1331
        self.timeout = datetime.timedelta(0, 0, 0, value)
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
 
 
 
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
    
2141
1353
    # ExtendedTimeout - property
2142
 
    @dbus_service_property(_interface,
2143
 
                           signature="t",
 
1354
    @dbus_service_property(_interface, signature="t",
2144
1355
                           access="readwrite")
2145
1356
    def ExtendedTimeout_dbus_property(self, value=None):
2146
1357
        if value is None:       # get
2147
 
            return dbus.UInt64(self.extended_timeout.total_seconds()
2148
 
                               * 1000)
 
1358
            return dbus.UInt64(self.extended_timeout_milliseconds())
2149
1359
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2150
 
 
 
1360
    
2151
1361
    # Interval - property
2152
 
    @dbus_service_property(_interface,
2153
 
                           signature="t",
 
1362
    @dbus_service_property(_interface, signature="t",
2154
1363
                           access="readwrite")
2155
1364
    def Interval_dbus_property(self, value=None):
2156
1365
        if value is None:       # get
2157
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1366
            return dbus.UInt64(self.interval_milliseconds())
2158
1367
        self.interval = datetime.timedelta(0, 0, 0, value)
2159
1368
        if getattr(self, "checker_initiator_tag", None) is None:
2160
1369
            return
2161
1370
        if self.enabled:
2162
1371
            # Reschedule checker run
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
 
 
 
1372
            gobject.source_remove(self.checker_initiator_tag)
 
1373
            self.checker_initiator_tag = (gobject.timeout_add
 
1374
                                          (value, self.start_checker))
 
1375
            self.start_checker()    # Start one now, too
 
1376
    
2168
1377
    # Checker - property
2169
 
    @dbus_service_property(_interface,
2170
 
                           signature="s",
 
1378
    @dbus_service_property(_interface, signature="s",
2171
1379
                           access="readwrite")
2172
1380
    def Checker_dbus_property(self, value=None):
2173
1381
        if value is None:       # get
2174
1382
            return dbus.String(self.checker_command)
2175
 
        self.checker_command = str(value)
2176
 
 
 
1383
        self.checker_command = unicode(value)
 
1384
    
2177
1385
    # CheckerRunning - property
2178
 
    @dbus_service_property(_interface,
2179
 
                           signature="b",
 
1386
    @dbus_service_property(_interface, signature="b",
2180
1387
                           access="readwrite")
2181
1388
    def CheckerRunning_dbus_property(self, value=None):
2182
1389
        if value is None:       # get
2185
1392
            self.start_checker()
2186
1393
        else:
2187
1394
            self.stop_checker()
2188
 
 
 
1395
    
2189
1396
    # ObjectPath - property
2190
 
    @dbus_annotations(
2191
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2192
 
         "org.freedesktop.DBus.Deprecated": "true"})
2193
1397
    @dbus_service_property(_interface, signature="o", access="read")
2194
1398
    def ObjectPath_dbus_property(self):
2195
 
        return self.dbus_object_path  # is already a dbus.ObjectPath
2196
 
 
 
1399
        return self.dbus_object_path # is already a dbus.ObjectPath
 
1400
    
2197
1401
    # Secret = property
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)
 
1402
    @dbus_service_property(_interface, signature="ay",
 
1403
                           access="write", byte_arrays=True)
2205
1404
    def Secret_dbus_property(self, value):
2206
 
        self.secret = bytes(value)
2207
 
 
 
1405
        self.secret = str(value)
 
1406
    
2208
1407
    del _interface
2209
1408
 
2210
1409
 
2211
1410
class ProxyClient(object):
2212
 
    def __init__(self, child_pipe, key_id, fpr, address):
 
1411
    def __init__(self, child_pipe, fpr, address):
2213
1412
        self._pipe = child_pipe
2214
 
        self._pipe.send(('init', key_id, fpr, address))
 
1413
        self._pipe.send(('init', fpr, address))
2215
1414
        if not self._pipe.recv():
2216
 
            raise KeyError(key_id or fpr)
2217
 
 
 
1415
            raise KeyError()
 
1416
    
2218
1417
    def __getattribute__(self, name):
2219
1418
        if name == '_pipe':
2220
1419
            return super(ProxyClient, self).__getattribute__(name)
2223
1422
        if data[0] == 'data':
2224
1423
            return data[1]
2225
1424
        if data[0] == 'function':
2226
 
 
2227
1425
            def func(*args, **kwargs):
2228
1426
                self._pipe.send(('funcall', name, args, kwargs))
2229
1427
                return self._pipe.recv()[1]
2230
 
 
2231
1428
            return func
2232
 
 
 
1429
    
2233
1430
    def __setattr__(self, name, value):
2234
1431
        if name == '_pipe':
2235
1432
            return super(ProxyClient, self).__setattr__(name, value)
2236
1433
        self._pipe.send(('setattr', name, value))
2237
1434
 
2238
1435
 
 
1436
class ClientDBusTransitional(ClientDBus):
 
1437
    __metaclass__ = AlternateDBusNamesMetaclass
 
1438
 
 
1439
 
2239
1440
class ClientHandler(socketserver.BaseRequestHandler, object):
2240
1441
    """A class to handle client connections.
2241
 
 
 
1442
    
2242
1443
    Instantiated once for each connection to handle it.
2243
1444
    Note: This will run in its own forked process."""
2244
 
 
 
1445
    
2245
1446
    def handle(self):
2246
1447
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2247
1448
            logger.info("TCP connection from: %s",
2248
 
                        str(self.client_address))
 
1449
                        unicode(self.client_address))
2249
1450
            logger.debug("Pipe FD: %d",
2250
1451
                         self.server.child_pipe.fileno())
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"))
 
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"))
2258
1467
            # Use a fallback default, since this MUST be set.
2259
1468
            priority = self.server.gnutls_priority
2260
1469
            if priority is None:
2261
1470
                priority = "NORMAL"
2262
 
            gnutls.priority_set_direct(session._c_object,
2263
 
                                       priority.encode("utf-8"),
2264
 
                                       None)
2265
 
 
 
1471
            (gnutls.library.functions
 
1472
             .gnutls_priority_set_direct(session._c_object,
 
1473
                                         priority, None))
 
1474
            
2266
1475
            # Start communication using the Mandos protocol
2267
1476
            # Get protocol number
2268
1477
            line = self.request.makefile().readline()
2269
1478
            logger.debug("Protocol version: %r", line)
2270
1479
            try:
2271
1480
                if int(line.strip().split()[0]) > 1:
2272
 
                    raise RuntimeError(line)
 
1481
                    raise RuntimeError
2273
1482
            except (ValueError, IndexError, RuntimeError) as error:
2274
1483
                logger.error("Unknown protocol version: %s", error)
2275
1484
                return
2276
 
 
 
1485
            
2277
1486
            # Start GnuTLS connection
2278
1487
            try:
2279
1488
                session.handshake()
2280
 
            except gnutls.Error as error:
 
1489
            except gnutls.errors.GNUTLSError as error:
2281
1490
                logger.warning("Handshake failed: %s", error)
2282
1491
                # Do not run session.bye() here: the session is not
2283
1492
                # established.  Just abandon the request.
2284
1493
                return
2285
1494
            logger.debug("Handshake succeeded")
2286
 
 
 
1495
            
2287
1496
            approval_required = False
2288
1497
            try:
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,
 
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,
2311
1509
                                         self.client_address)
2312
1510
                except KeyError:
2313
1511
                    return
2314
 
 
 
1512
                
 
1513
                if self.server.use_dbus:
 
1514
                    # Emit D-Bus signal
 
1515
                    client.NewRequest(str(self.client_address))
 
1516
                
2315
1517
                if client.approval_delay:
2316
1518
                    delay = client.approval_delay
2317
1519
                    client.approvals_pending += 1
2318
1520
                    approval_required = True
2319
 
 
 
1521
                
2320
1522
                while True:
2321
1523
                    if not client.enabled:
2322
1524
                        logger.info("Client %s is disabled",
2323
 
                                    client.name)
 
1525
                                       client.name)
2324
1526
                        if self.server.use_dbus:
2325
1527
                            # Emit D-Bus signal
2326
1528
                            client.Rejected("Disabled")
2327
1529
                        return
2328
 
 
 
1530
                    
2329
1531
                    if client.approved or not client.approval_delay:
2330
 
                        # We are approved or approval is disabled
 
1532
                        #We are approved or approval is disabled
2331
1533
                        break
2332
1534
                    elif client.approved is None:
2333
1535
                        logger.info("Client %s needs approval",
2335
1537
                        if self.server.use_dbus:
2336
1538
                            # Emit D-Bus signal
2337
1539
                            client.NeedApproval(
2338
 
                                client.approval_delay.total_seconds()
2339
 
                                * 1000, client.approved_by_default)
 
1540
                                client.approval_delay_milliseconds(),
 
1541
                                client.approved_by_default)
2340
1542
                    else:
2341
1543
                        logger.warning("Client %s was not approved",
2342
1544
                                       client.name)
2344
1546
                            # Emit D-Bus signal
2345
1547
                            client.Rejected("Denied")
2346
1548
                        return
2347
 
 
2348
 
                    # wait until timeout or approved
 
1549
                    
 
1550
                    #wait until timeout or approved
2349
1551
                    time = datetime.datetime.now()
2350
1552
                    client.changedstate.acquire()
2351
 
                    client.changedstate.wait(delay.total_seconds())
 
1553
                    (client.changedstate.wait
 
1554
                     (float(client.timedelta_to_milliseconds(delay)
 
1555
                            / 1000)))
2352
1556
                    client.changedstate.release()
2353
1557
                    time2 = datetime.datetime.now()
2354
1558
                    if (time2 - time) >= delay:
2364
1568
                            break
2365
1569
                    else:
2366
1570
                        delay -= time2 - time
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
 
 
 
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
                
2375
1584
                logger.info("Sending secret to %s", client.name)
2376
1585
                # bump the timeout using extended_timeout
2377
 
                client.bump_timeout(client.extended_timeout)
 
1586
                client.checked_ok(client.extended_timeout)
2378
1587
                if self.server.use_dbus:
2379
1588
                    # Emit D-Bus signal
2380
1589
                    client.GotSecret()
2381
 
 
 
1590
            
2382
1591
            finally:
2383
1592
                if approval_required:
2384
1593
                    client.approvals_pending -= 1
2385
1594
                try:
2386
1595
                    session.bye()
2387
 
                except gnutls.Error as error:
2388
 
                    logger.warning("GnuTLS bye failed",
2389
 
                                   exc_info=error)
2390
 
 
 
1596
                except gnutls.errors.GNUTLSError as error:
 
1597
                    logger.warning("GnuTLS bye failed")
 
1598
    
2391
1599
    @staticmethod
2392
1600
    def peer_certificate(session):
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""
 
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
2409
1608
        list_size = ctypes.c_uint(1)
2410
 
        cert_list = (gnutls.certificate_get_peers
 
1609
        cert_list = (gnutls.library.functions
 
1610
                     .gnutls_certificate_get_peers
2411
1611
                     (session._c_object, ctypes.byref(list_size)))
2412
1612
        if not bool(cert_list) and list_size.value != 0:
2413
 
            raise gnutls.Error("error getting peer certificate")
 
1613
            raise gnutls.errors.GNUTLSError("error getting peer"
 
1614
                                            " certificate")
2414
1615
        if list_size.value == 0:
2415
1616
            return None
2416
1617
        cert = cert_list[0]
2417
1618
        return ctypes.string_at(cert.data, cert.size)
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
 
 
 
1619
    
2453
1620
    @staticmethod
2454
1621
    def fingerprint(openpgp):
2455
1622
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2456
1623
        # New GnuTLS "datum" with the OpenPGP public key
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)))
 
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))))
2461
1629
        # New empty GnuTLS certificate
2462
 
        crt = gnutls.openpgp_crt_t()
2463
 
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
1630
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
1631
        (gnutls.library.functions
 
1632
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
2464
1633
        # Import the OpenPGP public key into the certificate
2465
 
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2466
 
                                  gnutls.OPENPGP_FMT_RAW)
 
1634
        (gnutls.library.functions
 
1635
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1636
                                    gnutls.library.constants
 
1637
                                    .GNUTLS_OPENPGP_FMT_RAW))
2467
1638
        # Verify the self signature in the key
2468
1639
        crtverify = ctypes.c_uint()
2469
 
        gnutls.openpgp_crt_verify_self(crt, 0,
2470
 
                                       ctypes.byref(crtverify))
 
1640
        (gnutls.library.functions
 
1641
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1642
                                         ctypes.byref(crtverify)))
2471
1643
        if crtverify.value != 0:
2472
 
            gnutls.openpgp_crt_deinit(crt)
2473
 
            raise gnutls.CertificateSecurityError(code
2474
 
                                                  =crtverify.value)
 
1644
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1645
            raise (gnutls.errors.CertificateSecurityError
 
1646
                   ("Verify failed"))
2475
1647
        # New buffer for the fingerprint
2476
1648
        buf = ctypes.create_string_buffer(20)
2477
1649
        buf_len = ctypes.c_size_t()
2478
1650
        # Get the fingerprint from the certificate into the buffer
2479
 
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2480
 
                                           ctypes.byref(buf_len))
 
1651
        (gnutls.library.functions
 
1652
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1653
                                             ctypes.byref(buf_len)))
2481
1654
        # Deinit the certificate
2482
 
        gnutls.openpgp_crt_deinit(crt)
 
1655
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2483
1656
        # Convert the buffer to a Python bytestring
2484
1657
        fpr = ctypes.string_at(buf, buf_len.value)
2485
1658
        # Convert the bytestring to hexadecimal notation
2489
1662
 
2490
1663
class MultiprocessingMixIn(object):
2491
1664
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2492
 
 
2493
1665
    def sub_process_main(self, request, address):
2494
1666
        try:
2495
1667
            self.finish_request(request, address)
2496
 
        except Exception:
 
1668
        except:
2497
1669
            self.handle_error(request, address)
2498
1670
        self.close_request(request)
2499
 
 
 
1671
    
2500
1672
    def process_request(self, request, address):
2501
1673
        """Start a new process to process the request."""
2502
 
        proc = multiprocessing.Process(target=self.sub_process_main,
2503
 
                                       args=(request, address))
 
1674
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1675
                                       args = (request,
 
1676
                                               address))
2504
1677
        proc.start()
2505
1678
        return proc
2506
1679
 
2507
1680
 
2508
1681
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2509
1682
    """ adds a pipe to the MixIn """
2510
 
 
2511
1683
    def process_request(self, request, client_address):
2512
1684
        """Overrides and wraps the original process_request().
2513
 
 
 
1685
        
2514
1686
        This function creates a new pipe in self.pipe
2515
1687
        """
2516
1688
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
2517
 
 
 
1689
        
2518
1690
        proc = MultiprocessingMixIn.process_request(self, request,
2519
1691
                                                    client_address)
2520
1692
        self.child_pipe.close()
2521
1693
        self.add_pipe(parent_pipe, proc)
2522
 
 
 
1694
    
2523
1695
    def add_pipe(self, parent_pipe, proc):
2524
1696
        """Dummy function; override as necessary"""
2525
 
        raise NotImplementedError()
 
1697
        raise NotImplementedError
2526
1698
 
2527
1699
 
2528
1700
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2529
1701
                     socketserver.TCPServer, object):
2530
1702
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2531
 
 
 
1703
    
2532
1704
    Attributes:
2533
1705
        enabled:        Boolean; whether this server is activated yet
2534
1706
        interface:      None or a network interface name (string)
2535
1707
        use_ipv6:       Boolean; to use IPv6 or not
2536
1708
    """
2537
 
 
2538
1709
    def __init__(self, server_address, RequestHandlerClass,
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
 
        """
 
1710
                 interface=None, use_ipv6=True):
2545
1711
        self.interface = interface
2546
1712
        if use_ipv6:
2547
1713
            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.
2575
1714
        socketserver.TCPServer.__init__(self, server_address,
2576
1715
                                        RequestHandlerClass)
2577
 
 
2578
1716
    def server_bind(self):
2579
1717
        """This overrides the normal server_bind() function
2580
1718
        to bind to an interface if one was specified, and also NOT to
2581
1719
        bind to an address or port if they were not specified."""
2582
 
        global SO_BINDTODEVICE
2583
1720
        if self.interface is not None:
2584
1721
            if SO_BINDTODEVICE is None:
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
 
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
2606
1742
        # Only bind(2) the socket if we really need to.
2607
1743
        if self.server_address[0] or self.server_address[1]:
2608
1744
            if not self.server_address[0]:
2609
1745
                if self.address_family == socket.AF_INET6:
2610
 
                    any_address = "::"  # in6addr_any
 
1746
                    any_address = "::" # in6addr_any
2611
1747
                else:
2612
 
                    any_address = "0.0.0.0"  # INADDR_ANY
 
1748
                    any_address = socket.INADDR_ANY
2613
1749
                self.server_address = (any_address,
2614
1750
                                       self.server_address[1])
2615
1751
            elif not self.server_address[1]:
2616
 
                self.server_address = (self.server_address[0], 0)
 
1752
                self.server_address = (self.server_address[0],
 
1753
                                       0)
2617
1754
#                 if self.interface:
2618
1755
#                     self.server_address = (self.server_address[0],
2619
1756
#                                            0, # port
2625
1762
 
2626
1763
class MandosServer(IPv6_TCPServer):
2627
1764
    """Mandos server.
2628
 
 
 
1765
    
2629
1766
    Attributes:
2630
1767
        clients:        set of Client objects
2631
1768
        gnutls_priority GnuTLS priority string
2632
1769
        use_dbus:       Boolean; to emit D-Bus signals or not
2633
 
 
2634
 
    Assumes a GLib.MainLoop event loop.
 
1770
    
 
1771
    Assumes a gobject.MainLoop event loop.
2635
1772
    """
2636
 
 
2637
1773
    def __init__(self, server_address, RequestHandlerClass,
2638
 
                 interface=None,
2639
 
                 use_ipv6=True,
2640
 
                 clients=None,
2641
 
                 gnutls_priority=None,
2642
 
                 use_dbus=True,
2643
 
                 socketfd=None):
 
1774
                 interface=None, use_ipv6=True, clients=None,
 
1775
                 gnutls_priority=None, use_dbus=True):
2644
1776
        self.enabled = False
2645
1777
        self.clients = clients
2646
1778
        if self.clients is None:
2649
1781
        self.gnutls_priority = gnutls_priority
2650
1782
        IPv6_TCPServer.__init__(self, server_address,
2651
1783
                                RequestHandlerClass,
2652
 
                                interface=interface,
2653
 
                                use_ipv6=use_ipv6,
2654
 
                                socketfd=socketfd)
2655
 
 
 
1784
                                interface = interface,
 
1785
                                use_ipv6 = use_ipv6)
2656
1786
    def server_activate(self):
2657
1787
        if self.enabled:
2658
1788
            return socketserver.TCPServer.server_activate(self)
2659
 
 
 
1789
    
2660
1790
    def enable(self):
2661
1791
        self.enabled = True
2662
 
 
 
1792
    
2663
1793
    def add_pipe(self, parent_pipe, proc):
2664
1794
        # Call "handle_ipc" for both data and EOF events
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):
 
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)
2676
1818
        # error, or the other end of multiprocessing.Pipe has closed
2677
 
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
 
1819
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2678
1820
            # Wait for other process to exit
2679
1821
            proc.join()
2680
1822
            return False
2681
 
 
 
1823
        
2682
1824
        # Read a request from the child
2683
1825
        request = parent_pipe.recv()
2684
1826
        command = request[0]
2685
 
 
 
1827
        
2686
1828
        if command == 'init':
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:
 
1829
            fpr = request[1]
 
1830
            address = request[2]
 
1831
            
 
1832
            for c in self.clients.itervalues():
 
1833
                if c.fingerprint == fpr:
2698
1834
                    client = c
2699
1835
                    break
2700
1836
            else:
2701
 
                logger.info("Client not found for key ID: %s, address"
2702
 
                            ": %s", key_id or fpr, address)
 
1837
                logger.info("Client not found for fingerprint: %s, ad"
 
1838
                            "dress: %s", fpr, address)
2703
1839
                if self.use_dbus:
2704
1840
                    # Emit D-Bus signal
2705
 
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
 
1841
                    mandos_dbus_service.ClientNotFound(fpr,
2706
1842
                                                       address[0])
2707
1843
                parent_pipe.send(False)
2708
1844
                return False
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))
 
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))
2717
1854
            parent_pipe.send(True)
2718
1855
            # remove the old hook in favor of the new above hook on
2719
1856
            # same fileno
2722
1859
            funcname = request[1]
2723
1860
            args = request[2]
2724
1861
            kwargs = request[3]
2725
 
 
 
1862
            
2726
1863
            parent_pipe.send(('data', getattr(client_object,
2727
1864
                                              funcname)(*args,
2728
 
                                                        **kwargs)))
2729
 
 
 
1865
                                                         **kwargs)))
 
1866
        
2730
1867
        if command == 'getattr':
2731
1868
            attrname = request[1]
2732
 
            if isinstance(client_object.__getattribute__(attrname),
2733
 
                          collections.Callable):
2734
 
                parent_pipe.send(('function', ))
 
1869
            if callable(client_object.__getattribute__(attrname)):
 
1870
                parent_pipe.send(('function',))
2735
1871
            else:
2736
 
                parent_pipe.send((
2737
 
                    'data', client_object.__getattribute__(attrname)))
2738
 
 
 
1872
                parent_pipe.send(('data', client_object
 
1873
                                  .__getattribute__(attrname)))
 
1874
        
2739
1875
        if command == 'setattr':
2740
1876
            attrname = request[1]
2741
1877
            value = request[2]
2742
1878
            setattr(client_object, attrname, value)
2743
 
 
 
1879
        
2744
1880
        return True
2745
1881
 
2746
1882
 
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
 
 
2846
1883
def string_to_delta(interval):
2847
1884
    """Parse a string and return a datetime.timedelta
2848
 
 
 
1885
    
2849
1886
    >>> string_to_delta('7d')
2850
1887
    datetime.timedelta(7)
2851
1888
    >>> string_to_delta('60s')
2859
1896
    >>> string_to_delta('5m 30s')
2860
1897
    datetime.timedelta(0, 330)
2861
1898
    """
2862
 
 
2863
 
    try:
2864
 
        return rfc3339_duration_to_delta(interval)
2865
 
    except ValueError:
2866
 
        pass
2867
 
 
2868
1899
    timevalue = datetime.timedelta(0)
2869
1900
    for s in interval.split():
2870
1901
        try:
2871
 
            suffix = s[-1]
 
1902
            suffix = unicode(s[-1])
2872
1903
            value = int(s[:-1])
2873
1904
            if suffix == "d":
2874
1905
                delta = datetime.timedelta(value)
2881
1912
            elif suffix == "w":
2882
1913
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2883
1914
            else:
2884
 
                raise ValueError("Unknown suffix {!r}".format(suffix))
2885
 
        except IndexError as e:
 
1915
                raise ValueError("Unknown suffix %r" % suffix)
 
1916
        except (ValueError, IndexError) as e:
2886
1917
            raise ValueError(*(e.args))
2887
1918
        timevalue += delta
2888
1919
    return timevalue
2889
1920
 
2890
1921
 
2891
 
def daemon(nochdir=False, noclose=False):
 
1922
def daemon(nochdir = False, noclose = False):
2892
1923
    """See daemon(3).  Standard BSD Unix function.
2893
 
 
 
1924
    
2894
1925
    This should really exist as os.daemon, but it doesn't (yet)."""
2895
1926
    if os.fork():
2896
1927
        sys.exit()
2901
1932
        sys.exit()
2902
1933
    if not noclose:
2903
1934
        # Close all standard open file descriptors
2904
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1935
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2905
1936
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2906
1937
            raise OSError(errno.ENODEV,
2907
 
                          "{} not a character device"
2908
 
                          .format(os.devnull))
 
1938
                          "%s not a character device"
 
1939
                          % os.path.devnull)
2909
1940
        os.dup2(null, sys.stdin.fileno())
2910
1941
        os.dup2(null, sys.stdout.fileno())
2911
1942
        os.dup2(null, sys.stderr.fileno())
2914
1945
 
2915
1946
 
2916
1947
def main():
2917
 
 
 
1948
    
2918
1949
    ##################################################################
2919
1950
    # Parsing of options, both command line and config file
2920
 
 
 
1951
    
2921
1952
    parser = argparse.ArgumentParser()
2922
1953
    parser.add_argument("-v", "--version", action="version",
2923
 
                        version="%(prog)s {}".format(version),
 
1954
                        version = "%%(prog)s %s" % version,
2924
1955
                        help="show version number and exit")
2925
1956
    parser.add_argument("-i", "--interface", metavar="IF",
2926
1957
                        help="Bind to interface IF")
2932
1963
                        help="Run self-test")
2933
1964
    parser.add_argument("--debug", action="store_true",
2934
1965
                        help="Debug mode; run in foreground and log"
2935
 
                        " to terminal", default=None)
 
1966
                        " to terminal")
2936
1967
    parser.add_argument("--debuglevel", metavar="LEVEL",
2937
1968
                        help="Debug level for stdout output")
2938
1969
    parser.add_argument("--priority", help="GnuTLS"
2945
1976
                        " files")
2946
1977
    parser.add_argument("--no-dbus", action="store_false",
2947
1978
                        dest="use_dbus", help="Do not provide D-Bus"
2948
 
                        " system bus interface", default=None)
 
1979
                        " system bus interface")
2949
1980
    parser.add_argument("--no-ipv6", action="store_false",
2950
 
                        dest="use_ipv6", help="Do not use IPv6",
2951
 
                        default=None)
 
1981
                        dest="use_ipv6", help="Do not use IPv6")
2952
1982
    parser.add_argument("--no-restore", action="store_false",
2953
1983
                        dest="restore", help="Do not restore stored"
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")
 
1984
                        " state")
2958
1985
    parser.add_argument("--statedir", metavar="DIR",
2959
1986
                        help="Directory to save/restore state in")
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
 
 
 
1987
    
2966
1988
    options = parser.parse_args()
2967
 
 
 
1989
    
2968
1990
    if options.check:
2969
1991
        import doctest
2970
 
        fail_count, test_count = doctest.testmod()
2971
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2972
 
 
 
1992
        doctest.testmod()
 
1993
        sys.exit()
 
1994
    
2973
1995
    # Default values for config file for server-global settings
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
 
 
 
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
    
2997
2010
    # Parse config file for server-global settings
2998
2011
    server_config = configparser.SafeConfigParser(server_defaults)
2999
2012
    del server_defaults
3000
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
2013
    server_config.read(os.path.join(options.configdir,
 
2014
                                    "mandos.conf"))
3001
2015
    # Convert the SafeConfigParser object to a dict
3002
2016
    server_settings = server_config.defaults()
3003
2017
    # Use the appropriate methods on the non-string config options
3004
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3005
 
                   "foreground", "zeroconf"):
 
2018
    for option in ("debug", "use_dbus", "use_ipv6"):
3006
2019
        server_settings[option] = server_config.getboolean("DEFAULT",
3007
2020
                                                           option)
3008
2021
    if server_settings["port"]:
3009
2022
        server_settings["port"] = server_config.getint("DEFAULT",
3010
2023
                                                       "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"])
3020
2024
    del server_config
3021
 
 
 
2025
    
3022
2026
    # Override the settings from the config file with command line
3023
2027
    # options, if set.
3024
2028
    for option in ("interface", "address", "port", "debug",
3025
 
                   "priority", "servicename", "configdir", "use_dbus",
3026
 
                   "use_ipv6", "debuglevel", "restore", "statedir",
3027
 
                   "socket", "foreground", "zeroconf"):
 
2029
                   "priority", "servicename", "configdir",
 
2030
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2031
                   "statedir"):
3028
2032
        value = getattr(options, option)
3029
2033
        if value is not None:
3030
2034
            server_settings[option] = value
3031
2035
    del options
3032
2036
    # Force all strings to be unicode
3033
2037
    for option in server_settings.keys():
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
 
2038
        if type(server_settings[option]) is str:
 
2039
            server_settings[option] = unicode(server_settings[option])
3044
2040
    # Now we have our good server settings in "server_settings"
3045
 
 
 
2041
    
3046
2042
    ##################################################################
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
 
 
 
2043
    
3053
2044
    # For convenience
3054
2045
    debug = server_settings["debug"]
3055
2046
    debuglevel = server_settings["debuglevel"]
3057
2048
    use_ipv6 = server_settings["use_ipv6"]
3058
2049
    stored_state_path = os.path.join(server_settings["statedir"],
3059
2050
                                     stored_state_file)
3060
 
    foreground = server_settings["foreground"]
3061
 
    zeroconf = server_settings["zeroconf"]
3062
 
 
 
2051
    
3063
2052
    if debug:
3064
 
        initlogger(debug, logging.DEBUG)
 
2053
        initlogger(logging.DEBUG)
3065
2054
    else:
3066
2055
        if not debuglevel:
3067
 
            initlogger(debug)
 
2056
            initlogger()
3068
2057
        else:
3069
2058
            level = getattr(logging, debuglevel.upper())
3070
 
            initlogger(debug, level)
3071
 
 
 
2059
            initlogger(level)
 
2060
    
3072
2061
    if server_settings["servicename"] != "Mandos":
3073
 
        syslogger.setFormatter(
3074
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
3075
 
                              ' %(levelname)s: %(message)s'.format(
3076
 
                                  server_settings["servicename"])))
3077
 
 
 
2062
        syslogger.setFormatter(logging.Formatter
 
2063
                               ('Mandos (%s) [%%(process)d]:'
 
2064
                                ' %%(levelname)s: %%(message)s'
 
2065
                                % server_settings["servicename"]))
 
2066
    
3078
2067
    # Parse config file with clients
3079
 
    client_config = configparser.SafeConfigParser(Client
3080
 
                                                  .client_defaults)
 
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)
3081
2077
    client_config.read(os.path.join(server_settings["configdir"],
3082
2078
                                    "clients.conf"))
3083
 
 
 
2079
    
3084
2080
    global mandos_dbus_service
3085
2081
    mandos_dbus_service = None
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
 
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
3116
2106
        except KeyError:
3117
 
            continue
3118
 
    else:
3119
 
        uid = 65534
3120
 
        gid = 65534
 
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
3121
2113
    try:
3122
2114
        os.setgid(gid)
3123
2115
        os.setuid(uid)
3124
 
        if debug:
3125
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3126
 
                                                             gid))
3127
2116
    except OSError as error:
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
 
 
 
2117
        if error[0] != errno.EPERM:
 
2118
            raise error
 
2119
    
3133
2120
    if debug:
3134
2121
        # Enable all possible GnuTLS debugging
3135
 
 
 
2122
        
3136
2123
        # "Use a log level over 10 to enable all debugging options."
3137
2124
        # - GnuTLS manual
3138
 
        gnutls.global_set_log_level(11)
3139
 
 
3140
 
        @gnutls.log_func
 
2125
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2126
        
 
2127
        @gnutls.library.types.gnutls_log_func
3141
2128
        def debug_gnutls(level, string):
3142
2129
            logger.debug("GnuTLS: %s", string[:-1])
3143
 
 
3144
 
        gnutls.global_set_log_function(debug_gnutls)
3145
 
 
 
2130
        
 
2131
        (gnutls.library.functions
 
2132
         .gnutls_global_set_log_function(debug_gnutls))
 
2133
        
3146
2134
        # Redirect stdin so all checkers get /dev/null
3147
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
2135
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3148
2136
        os.dup2(null, sys.stdin.fileno())
3149
2137
        if null > 2:
3150
2138
            os.close(null)
3151
 
 
 
2139
    else:
 
2140
        # No console logging
 
2141
        logger.removeHandler(console)
 
2142
    
3152
2143
    # Need to fork before connecting to D-Bus
3153
 
    if not foreground:
 
2144
    if not debug:
3154
2145
        # Close all input and output, do double fork, etc.
3155
2146
        daemon()
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
 
 
 
2147
    
3161
2148
    global main_loop
3162
2149
    # From the Avahi example code
3163
 
    DBusGMainLoop(set_as_default=True)
3164
 
    main_loop = GLib.MainLoop()
 
2150
    DBusGMainLoop(set_as_default=True )
 
2151
    main_loop = gobject.MainLoop()
3165
2152
    bus = dbus.SystemBus()
3166
2153
    # End of Avahi example code
3167
2154
    if use_dbus:
3168
2155
        try:
3169
2156
            bus_name = dbus.service.BusName("se.recompile.Mandos",
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)
 
2157
                                            bus, do_not_queue=True)
 
2158
            old_bus_name = (dbus.service.BusName
 
2159
                            ("se.bsnet.fukt.Mandos", bus,
 
2160
                             do_not_queue=True))
 
2161
        except dbus.exceptions.NameExistsException as e:
 
2162
            logger.error(unicode(e) + ", disabling D-Bus")
3177
2163
            use_dbus = False
3178
2164
            server_settings["use_dbus"] = False
3179
2165
            tcp_server.use_dbus = False
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
 
 
 
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
    
3191
2175
    global multiprocessing_manager
3192
2176
    multiprocessing_manager = multiprocessing.Manager()
3193
 
 
 
2177
    
3194
2178
    client_class = Client
3195
2179
    if use_dbus:
3196
 
        client_class = functools.partial(ClientDBus, bus=bus)
3197
 
 
3198
 
    client_settings = Client.config_parser(client_config)
 
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
    
3199
2206
    old_client_settings = {}
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
 
 
 
2207
    clients_data = []
 
2208
    
3210
2209
    # Get client data and settings from last running state.
3211
2210
    if server_settings["restore"]:
3212
2211
        try:
3213
2212
            with open(stored_state_path, "rb") as 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"))
 
2213
                clients_data, old_client_settings = (pickle.load
 
2214
                                                     (stored_state))
3263
2215
            os.remove(stored_state_path)
3264
2216
        except IOError as e:
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)
 
2217
            logger.warning("Could not load persistent state: {0}"
 
2218
                           .format(e))
 
2219
            if e.errno != errno.ENOENT:
3271
2220
                raise
3272
 
        except EOFError as e:
3273
 
            logger.warning("Could not load persistent state: "
3274
 
                           "EOFError:",
3275
 
                           exc_info=e)
3276
 
 
 
2221
    
3277
2222
    with PGPEngine() as pgp:
3278
 
        for client_name, client in clients_data.items():
3279
 
            # Skip removed clients
3280
 
            if client_name not in client_settings:
3281
 
                continue
3282
 
 
 
2223
        for client in clients_data:
 
2224
            client_name = client["name"]
 
2225
            
3283
2226
            # Decide which value to use after restoring saved state.
3284
2227
            # We have three different values: Old config file,
3285
2228
            # new config file, and saved state.
3290
2233
                    # For each value in new config, check if it
3291
2234
                    # differs from the old config value (Except for
3292
2235
                    # the "secret" attribute)
3293
 
                    if (name != "secret"
3294
 
                        and (value !=
3295
 
                             old_client_settings[client_name][name])):
3296
 
                        client[name] = value
 
2236
                    if (name != "secret" and
 
2237
                        value != old_client_settings[client_name]
 
2238
                        [name]):
 
2239
                        setattr(client, name, value)
3297
2240
                except KeyError:
3298
2241
                    pass
3299
 
 
 
2242
            
3300
2243
            # Clients who has passed its expire date can still be
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.
 
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.
3305
2247
            if client["enabled"]:
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"]))
 
2248
                if client["expires"] <= (datetime.datetime
 
2249
                                         .utcnow()):
 
2250
                    # Client has expired
 
2251
                    if client["last_checker_status"] != 0:
3320
2252
                        client["enabled"] = False
3321
2253
                    else:
3322
 
                        client["expires"] = (
3323
 
                            datetime.datetime.utcnow()
3324
 
                            + client["timeout"])
3325
 
                        logger.debug("Last checker succeeded,"
3326
 
                                     " keeping {} enabled".format(
3327
 
                                         client_name))
 
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
            
3328
2286
            try:
3329
 
                client["secret"] = pgp.decrypt(
3330
 
                    client["encrypted_secret"],
3331
 
                    client_settings[client_name]["secret"])
 
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"]))
3332
2292
            except PGPError:
3333
2293
                # If decryption fails, we use secret from new settings
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
 
 
 
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
    
3354
2309
    if not tcp_server.clients:
3355
2310
        logger.warning("No clients defined")
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
 
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
3367
2324
        del pidfilename
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
 
 
 
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
    
3373
2331
    if use_dbus:
3374
 
 
3375
 
        @alternate_dbus_interfaces(
3376
 
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3377
 
        class MandosDBusService(DBusObjectWithObjectManager):
 
2332
        class MandosDBusService(dbus.service.Object):
3378
2333
            """A D-Bus proxy object"""
3379
 
 
3380
2334
            def __init__(self):
3381
2335
                dbus.service.Object.__init__(self, bus, "/")
3382
 
 
3383
2336
            _interface = "se.recompile.Mandos"
3384
 
 
 
2337
            
3385
2338
            @dbus.service.signal(_interface, signature="o")
3386
2339
            def ClientAdded(self, objpath):
3387
2340
                "D-Bus signal"
3388
2341
                pass
3389
 
 
 
2342
            
3390
2343
            @dbus.service.signal(_interface, signature="ss")
3391
 
            def ClientNotFound(self, key_id, address):
 
2344
            def ClientNotFound(self, fingerprint, address):
3392
2345
                "D-Bus signal"
3393
2346
                pass
3394
 
 
3395
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3396
 
                               "true"})
 
2347
            
3397
2348
            @dbus.service.signal(_interface, signature="os")
3398
2349
            def ClientRemoved(self, objpath, name):
3399
2350
                "D-Bus signal"
3400
2351
                pass
3401
 
 
3402
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3403
 
                               "true"})
 
2352
            
3404
2353
            @dbus.service.method(_interface, out_signature="ao")
3405
2354
            def GetAllClients(self):
3406
2355
                "D-Bus method"
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"})
 
2356
                return dbus.Array(c.dbus_object_path
 
2357
                                  for c in
 
2358
                                  tcp_server.clients.itervalues())
 
2359
            
3412
2360
            @dbus.service.method(_interface,
3413
2361
                                 out_signature="a{oa{sv}}")
3414
2362
            def GetAllClientsWithProperties(self):
3415
2363
                "D-Bus method"
3416
2364
                return dbus.Dictionary(
3417
 
                    {c.dbus_object_path: c.GetAll(
3418
 
                        "se.recompile.Mandos.Client")
3419
 
                     for c in tcp_server.clients.values()},
 
2365
                    ((c.dbus_object_path, c.GetAll(""))
 
2366
                     for c in tcp_server.clients.itervalues()),
3420
2367
                    signature="oa{sv}")
3421
 
 
 
2368
            
3422
2369
            @dbus.service.method(_interface, in_signature="o")
3423
2370
            def RemoveClient(self, object_path):
3424
2371
                "D-Bus method"
3425
 
                for c in tcp_server.clients.values():
 
2372
                for c in tcp_server.clients.itervalues():
3426
2373
                    if c.dbus_object_path == object_path:
3427
2374
                        del tcp_server.clients[c.name]
3428
2375
                        c.remove_from_connection()
3429
 
                        # Don't signal the disabling
 
2376
                        # Don't signal anything except ClientRemoved
3430
2377
                        c.disable(quiet=True)
3431
 
                        # Emit D-Bus signal for removal
3432
 
                        self.client_removed_signal(c)
 
2378
                        # Emit D-Bus signal
 
2379
                        self.ClientRemoved(object_path, c.name)
3433
2380
                        return
3434
2381
                raise KeyError(object_path)
3435
 
 
 
2382
            
3436
2383
            del _interface
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
 
 
 
2384
        
 
2385
        class MandosDBusServiceTransitional(MandosDBusService):
 
2386
            __metaclass__ = AlternateDBusNamesMetaclass
 
2387
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2388
    
3481
2389
    def cleanup():
3482
2390
        "Cleanup function; run on exit"
3483
 
        if zeroconf:
3484
 
            service.cleanup()
3485
 
 
3486
 
        mp.active_children()
3487
 
        wn.close()
 
2391
        service.cleanup()
 
2392
        
 
2393
        multiprocessing.active_children()
3488
2394
        if not (tcp_server.clients or client_settings):
3489
2395
            return
3490
 
 
 
2396
        
3491
2397
        # Store client before exiting. Secrets are encrypted with key
3492
2398
        # based on what config file has. If config file is
3493
2399
        # removed/edited, old secret will thus be unrecovable.
3494
 
        clients = {}
 
2400
        clients = []
3495
2401
        with PGPEngine() as pgp:
3496
 
            for client in tcp_server.clients.values():
 
2402
            for client in tcp_server.clients.itervalues():
3497
2403
                key = client_settings[client.name]["secret"]
3498
2404
                client.encrypted_secret = pgp.encrypt(client.secret,
3499
2405
                                                      key)
3500
2406
                client_dict = {}
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):
 
2407
                
 
2408
                # A list of attributes that will not be stored when
 
2409
                # shutting down.
 
2410
                exclude = set(("bus", "changedstate", "secret"))
 
2411
                for name, typ in (inspect.getmembers
 
2412
                                  (dbus.service.Object)):
3508
2413
                    exclude.add(name)
3509
 
 
 
2414
                
3510
2415
                client_dict["encrypted_secret"] = (client
3511
2416
                                                   .encrypted_secret)
3512
2417
                for attr in client.client_structure:
3513
2418
                    if attr not in exclude:
3514
2419
                        client_dict[attr] = getattr(client, attr)
3515
 
 
3516
 
                clients[client.name] = client_dict
 
2420
                
 
2421
                clients.append(client_dict)
3517
2422
                del client_settings[client.name]["secret"]
3518
 
 
 
2423
        
3519
2424
        try:
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)
 
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)
3530
2429
        except (IOError, OSError) as e:
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)
 
2430
            logger.warning("Could not save persistent state: {0}"
 
2431
                           .format(e))
 
2432
            if e.errno not in (errno.ENOENT, errno.EACCES):
3542
2433
                raise
3543
 
 
 
2434
        
3544
2435
        # Delete all clients, and settings from config
3545
2436
        while tcp_server.clients:
3546
2437
            name, client = tcp_server.clients.popitem()
3547
2438
            if use_dbus:
3548
2439
                client.remove_from_connection()
3549
 
            # Don't signal the disabling
 
2440
            # Don't signal anything except ClientRemoved
3550
2441
            client.disable(quiet=True)
3551
 
            # Emit D-Bus signal for removal
3552
2442
            if use_dbus:
3553
 
                mandos_dbus_service.client_removed_signal(client)
 
2443
                # Emit D-Bus signal
 
2444
                mandos_dbus_service.ClientRemoved(client
 
2445
                                                  .dbus_object_path,
 
2446
                                                  client.name)
3554
2447
        client_settings.clear()
3555
 
 
 
2448
    
3556
2449
    atexit.register(cleanup)
3557
 
 
3558
 
    for client in tcp_server.clients.values():
 
2450
    
 
2451
    for client in tcp_server.clients.itervalues():
3559
2452
        if use_dbus:
3560
 
            # Emit D-Bus signal for adding
3561
 
            mandos_dbus_service.client_added_signal(client)
 
2453
            # Emit D-Bus signal
 
2454
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
3562
2455
        # Need to initiate checking of clients
3563
2456
        if client.enabled:
3564
2457
            client.init_checker()
3565
 
 
 
2458
    
3566
2459
    tcp_server.enable()
3567
2460
    tcp_server.server_activate()
3568
 
 
 
2461
    
3569
2462
    # Find out what port we got
3570
 
    if zeroconf:
3571
 
        service.port = tcp_server.socket.getsockname()[1]
 
2463
    service.port = tcp_server.socket.getsockname()[1]
3572
2464
    if use_ipv6:
3573
2465
        logger.info("Now listening on address %r, port %d,"
3574
 
                    " flowinfo %d, scope_id %d",
3575
 
                    *tcp_server.socket.getsockname())
 
2466
                    " flowinfo %d, scope_id %d"
 
2467
                    % tcp_server.socket.getsockname())
3576
2468
    else:                       # IPv4
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
 
 
 
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
    
3582
2474
    try:
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
 
 
 
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
        
3598
2489
        logger.debug("Starting main loop")
3599
2490
        main_loop.run()
3600
2491
    except AvahiError as error:
3601
 
        logger.critical("Avahi Error", exc_info=error)
 
2492
        logger.critical("AvahiError: %s", error)
3602
2493
        cleanup()
3603
2494
        sys.exit(1)
3604
2495
    except KeyboardInterrupt: