/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-30 18:44:31 UTC
  • mto: This revision was merged to the branch mainline in revision 1134.
  • Revision ID: teddy@recompile.se-20190730184431-nqlgghaw2aqe6if6
Tags: version-1.8.5-1
http://bugs.debian.org/933387
* Makefile (version): Change to 1.8.5.
* NEWS (Version 1.8.5): Add new entry.
* debian/changelog (1.8.5-1): - '' -

Show diffs side-by-side

added added

removed removed

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