/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: 2016-10-05 20:58:06 UTC
  • mfrom: (237.4.84 release)
  • Revision ID: teddy@recompile.se-20161005205806-14z03l0dow1y69mj
Merge from release branch

Show diffs side-by-side

added added

removed removed

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