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