/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: 2023-02-11 06:58:15 UTC
  • Revision ID: teddy@recompile.se-20230211065815-jtffi61tbdrgr875
Suppress warnings

Suppress warnings about mlock()ing uninitialized memory and reading an
ievent struct.

* dracut-module/password-agent.c (send_password_to_socket): Suppress
  "-Wmaybe-uninitialized" when mlock()ing password send buffer.
  (test_read_inotify_event_IN_DELETE_badname): When reading from
    a struct ievent, suppress "-Wstringop-overread".

Show diffs side-by-side

added added

removed removed

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