/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:31:44 UTC
  • Revision ID: teddy@recompile.se-20190209233144-5ewmrgezdqridssj
* TODO (Use raw public keys): Remove.

Show diffs side-by-side

added added

removed removed

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