/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-02-10 03:50:20 UTC
  • Revision ID: teddy@recompile.se-20190210035020-nttr1tybgwwixueu
Show debconf note about new TLS key IDs

If mandos-client did not see TLS keys and had to create them, or if
mandos sees GnuTLS version 3.6.6 or later, show an important notice on
package installation about the importance of adding the new key_id
options to clients.conf on the Mandos server.

* debian/control (Package: mandos, Package: mandos-client): Depend on
                                                            debconf.
* debian/mandos-client.lintian-overrides: Override warnings.
* debian/mandos-client.postinst (create_keys): Show notice if new TLS
                                               key files were created.
* debian/mandos-client.templates: New.
* debian/mandos.lintian-overrides: Override warnings.
* debian/mandos.postinst (configure): If GnuTLS 3.6.6 or later is
                                      detected, show an important
                                      notice (once) about the new
                                      key_id option required in
                                      clients.conf.
* debian/mandos.templates: New.

Show diffs side-by-side

added added

removed removed

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