/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: 2021-02-03 08:33:43 UTC
  • Revision ID: teddy@recompile.se-20210203083343-spdbhxgd5v8e3lv9
Update copyright year

* debian/copyright: Update copyright year to 2021.
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: Update copyright year to 2020.
* intro.xml: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: Update copyright year
  to 2021.
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

Show diffs side-by-side

added added

removed removed

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