/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: 2017-08-20 14:14:14 UTC
  • Revision ID: teddy@recompile.se-20170820141414-m034xuebg7ccaeui
Add some more restrictions to the systemd service file.

* mandos.service ([Service]/ProtectKernelTunables): New; set to "yes".
  ([Service]/ProtectControlGroups): - '' -

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