/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: 2014-08-09 23:37:07 UTC
  • Revision ID: teddy@recompile.se-20140809233707-6c5qyievp78lnzf1
askpass-fifo: Lower privileges after opening FIFO.

* plugins.d/askpass-fifo.c (main): Lower privileges after opening FIFO.

Show diffs side-by-side

added added

removed removed

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