/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2012-06-17 22:26:40 UTC
  • mfrom: (301.1.1 release)
  • Revision ID: teddy@recompile.se-20120617222640-49scfn0husnrr5bi
Tags: version-1.6.0-1
* Makefile (version): Changed to "1.6.0".
* NEWS (Version 1.6.0): New entry.
* debian/changelog (1.6.0-1): - '' -

Show diffs side-by-side

added added

removed removed

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