/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 at recompile
  • Date: 2020-02-05 21:39:28 UTC
  • Revision ID: teddy@recompile.se-20200205213928-vpvt0fwfg47ikv6f
Allow users to alter ask-password-mandos.service

If a user uses dracut with systemd and wishes to modify the options
passed to password-agent(8mandos) or mandos-client(8mandos), they
should be able to do so by simply creating a file
/etc/systemd/system/ask-password-mandos.service.d/override.conf,
containing, for instance:

[Service]
Environment=MANDOS_CLIENT_OPTIONS=--debug

Adding PASSWORD_AGENT_OPTIONS should also be possible (but should not
normally be needed).

* dracut-module/ask-password-mandos.service ([Service]/ExecStart): Add
  $PASSWORD_AGENT_OPTIONS before "--" and "$MANDOS_CLIENT_OPTIONS" to
  end of line.
* dracut-module/module-setup.sh (install): Install all files named
  /etc/systemd/system/ask-password-mandos.service.d/*.conf if any
  exists.  Also add --dh-params before $MANDOS_CLIENT_OPTIONS instead
  of at end of line.

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