/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-10-13 06:12:52 UTC
  • Revision ID: teddy@fukt.bsnet.se-20101013061252-3a918xedja5caya8
* debian/mandos-client.lintian-overrides: Added plugins.d/plymouth.

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