/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: 2012-06-17 22:26:40 UTC
  • mfrom: (301.1.1 release)
  • Revision ID: teddy@recompile.se-20120617222640-49scfn0husnrr5bi
Tags: version-1.6.0-1
* Makefile (version): Changed to "1.6.0".
* NEWS (Version 1.6.0): New entry.
* debian/changelog (1.6.0-1): - '' -

Show diffs side-by-side

added added

removed removed

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