/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-07-27 10:11:45 UTC
  • Revision ID: teddy@recompile.se-20190727101145-jnpbpf8220gldbcd
Add dracut(8) support

Add support for the dracut(8) system for generating initramfs image
files; dracut is an alternative to the "initramfs-tools" package.

* .bzrignore (dracut-module/password-agent): Ignore new binary file.
* dracut-module: New directory for the dracut module.
* INSTALL (Prerequisites/Libraries/Mandos Client): Add dracut as an
                                                   alternative to
                                                   initramfs-tools,
                                                   and also add GLib.
* Makefile (DRACUTMODULE, GLIB_CFLAGS, GLIB_LIBS): New.
  (CPROGS): Add "dracut-module/password-agent".
  (DOCS): Add "dracut-module/password-agent.8mandos".
  (dracut-module/password-agent.8mandos): New.
  (dracut-module/password-agent.8mandos.xhtml): - '' -
  (dracut-module/password-agent): - '' -
  (check): Add command to run tests of password-agent(8mandos).
  (install-client-nokey): Also install the dracut module directory,
                          its files, and the password-agent(8mandos)
                          manual page.
  (install-client): To update the initramfs image file, run
                    update-initramfs or dracut depending on what is
                    installed.
  (uninstall-client): - '' - and also uninstall the the files in the
                      dracut module directory, that directory itself,
                      and the password-agent(8mandos) manual page.
* debian/control (Build-Depends): Add "libglib2.0-dev (>=2.40)".
  (Package: mandos-client/Depends): Add "dracut (>= 044+241-3)" as an
                                    alternative dependency to
                                    initramfs-tools.
  (Package: mandos-client/Conflicts): New; set to
                                      "dracut-config-generic".
  (debian/mandos-client.README.Debian): Document alternative commands
                                        to update the initramfs image
                                        for when dracut is used.
* debian/mandos-client.postinst (update_initramfs): Use alternative
                                                    commands to update
                                                    the initramfs
                                                    image for when
                                                    dracut is used.
* debian/tests/control (password-agent, password-agent-suid): Add two
                                                              new tests.
* dracut-module/ask-password-mandos.path: New.
* dracut-module/ask-password-mandos.service: - '' -
* dracut-module/cmdline-mandos.sh: - '' -
* dracut-module/module-setup.sh: - '' -
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: - '' -
* initramfs-unpack: Use the dracut "skipcpio" command, if available.
                    Also be more flexible and try hard to detect where
                    compressed data starts.
* plugins.d/mandos-client.xml (SECURITY): Be more precise that the
                                          mandos-client binary might
                                          not always be setuid, but
                                          that the program assumes
                                          that it has been started
                                          that way.
* plugins.d/password-prompt.c: Add new "--prompt" option.
  (conflict_detection): First try to detect the new PID file of
                        plymouth.
  (main): Define and use new "prompt" variable.
* plugins.d/password-prompt.xml (SYNOPSIS): Show new --prompt option.
  (DESCRIPTION): Describe new behavior of looking for plymouth PID
                 file.
  (OPTIONS): Document new "--prompt" option.
  (ENVIRONMENT): Clarify that the CRYPTTAB_SOURCE and CRYPTTAB_NAME
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the CRYPTTAB_SOURCE and
                 CRYPTTAB_NAME comes from, since this can now be
                 either initramfs-tools or dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference, and add commas
              to separate the other references.
* plugins.d/plymouth.c: Add new "--prompt" and "--debug" options.
  (debug): New global flag.
  (fprintf_plus): New function, used for debug output.
  (exec_and_wait): Add extra "const" to "argv" argument.
  (main): Define and use new "prompt" variable.  Add debug output.
  (main/options, main/parse_opt): New; used to parse options.
* plugins.d/plymouth.xml (SYNOPSIS): Show new options.
  (OPTIONS): Document new options.
  (ENVIRONMENT): Clarify that the cryptsource and crypttarget
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the cryptsource and crypttarget
                 comes from, since this can now be either
                 initramfs-tools or dracut.
  (EXAMPLE): Add an example using an option.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/splashy.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/usplash.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.

Show diffs side-by-side

added added

removed removed

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