/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2018-02-18 01:29:21 UTC
  • Revision ID: teddy@recompile.se-20180218012921-itiazxid50ycv77o
Correct comments

* plugin-helpers/mandos-client-iprouteadddel.c: Comment change only.

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