/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2010-09-25 23:52:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100925235217-4hhqfryz1ste6uw3
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
                                to "_" in D-Bus object paths.
  (MandosServer.handle_ipc): Bug fix: Send only address string to
                             D-Bus signal, not whole tuple.

* mandos-ctl: New options "--approve-by-default", "--deny-by-default",
              "--approval-delay", and "--approval-duration".
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new options.

* mandos-monitor (MandosClientWidget.update): Fix spelling.

Show diffs side-by-side

added added

removed removed

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