/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

working new feature: network-hooks - Enables user-scripts to take up
                     interfaces during bootup

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