/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-02-16 02:42:42 UTC
  • Revision ID: teddy@recompile.se-20140216024242-9wiw1nkxgt7ohovj
Fix running of self-tests.

* debian/control (Build-Depends): Add Python dependencies to
                                  successfully run self-tests.
* debian/copyright: GPLv3 now has its own license file - use it.
* debian/watch: Set PGP signature URL.
* mandos (main): Bug fix: When running self-tests, set exit code.
* mandos-ctl (main): Cosmetic fix; use os.EX_OK instead of plain 0.

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