/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-04-02 18:59:29 UTC
  • mto: (237.7.304 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150402185929-1q1rf1zelbpzzn74
Add "!RSA" also to examples/documentation.

* mandos.conf (priority): Add "!RSA" to default commented-out value.
* mandos.conf.xml (EXAMPLE): Add "!RSA" to example priority setting.

Show diffs side-by-side

added added

removed removed

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