/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: 2016-02-21 14:24:01 UTC
  • Revision ID: teddy@recompile.se-20160221142401-j7glu6a2hg604d1e
Use AddressSanitizer and UndefinedBehaviorSanitizer.

* Makefile (SANITIZE): New; set to all sanitizing options depending on
                       GCC version.
  (CFLAGS): Added "$(SANITIZE)".

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