/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-08-05 14:31:51 UTC
  • Revision ID: teddy@recompile.se-20190805143151-lt5d97wqif3t8250
Client: Debian package fix: Make uninstall when using dracut(8) work

Use the same logic to rebuild the initramfs image when uninstalling as
when installing the package.

* debian/mandos-client.postrm (update_initramfs): Use the same logic
  as the update_initramfs function in debian/mandos-client.postinst.

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