/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

half working on-demand password and approved code

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