/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-03-02 16:45:38 UTC
  • Revision ID: teddy@recompile.se-20160302164538-n9ocll4izthzw1ov
Ignore any error from initramfs-tools' "configure_networking".

* initramfs-tools-script: Wrap call to "configure_networking" with
  "set +e" and "set -e", since configure_networking was not designed
  to run in a "set -e" environment.

Closes: 816513
Thanks: Carlos Alberto Lopez Perez <clopez@igalia.com>
Thanks: Ben Hutchings <ben@decadent.org.uk>

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