/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-08-25 17:37:05 UTC
  • Revision ID: teddy@recompile.se-20160825173705-q2v6lban8ph9uw75
PEP8 compliance: mandos

* mandos: Add PEP8 compliance (as per the "pycodestyle" tool).

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