/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 at recompile
  • Date: 2011-12-31 13:25:58 UTC
  • mto: This revision was merged to the branch mainline in revision 541.
  • Revision ID: teddy@recompile.se-20111231132558-z0dh7qgofgctmgri
* network-hooks.s/bridge: Don't use interface names directly; search
                          for interface names using their address.
  (addrtoif): New function.
* network-hooks.s/bridge.conf (PORTS): Removed.
  (PORT_ADDRESSES): New.
* network-hooks.s/wireless: Don't use interface names directly; search
                            for interface names using their address.
  (addrtoif): New function.
* network-hooks.s/wireless.conf: Specify address.

Show diffs side-by-side

added added

removed removed

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