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