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