/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: 2018-02-06 20:03:50 UTC
  • Revision ID: teddy@recompile.se-20180206200350-jzvorueb731xkph3
Update Debian Debhelper compatibility version.

* (debian/compat): Change to "10".

Show diffs side-by-side

added added

removed removed

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