/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

* mandos-ctl: Bug fix: only show properties of specifies clients.

Show diffs side-by-side

added added

removed removed

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