/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-09 21:48:47 UTC
  • Revision ID: teddy@recompile.se-20180209214847-z9gcxqa6827z0ir5
Server bug fix: Correct bad argument list

* (mandos/AvahiServiceToSyslog.rename): Remove "self" from the
  arguments to the method when using super().

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
90
 
 
91
 
version = "1.6.7"
 
101
        # In Python 2.7 it seems to have been removed entirely.
 
102
        # Try running the C preprocessor:
 
103
        try:
 
104
            cc = subprocess.Popen(["cc", "--language=c", "-E",
 
105
                                   "/dev/stdin"],
 
106
                                  stdin=subprocess.PIPE,
 
107
                                  stdout=subprocess.PIPE)
 
108
            stdout = cc.communicate(
 
109
                "#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
 
110
            SO_BINDTODEVICE = int(stdout.splitlines()[-1])
 
111
        except (OSError, ValueError, IndexError):
 
112
            # No value found
 
113
            SO_BINDTODEVICE = None
 
114
 
 
115
if sys.version_info.major == 2:
 
116
    str = unicode
 
117
 
 
118
version = "1.7.16"
92
119
stored_state_file = "clients.pickle"
93
120
 
94
121
logger = logging.getLogger()
95
122
syslogger = None
96
123
 
97
124
try:
98
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
99
 
                      (ctypes.util.find_library("c"))
100
 
                      .if_nametoindex)
 
125
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
126
        ctypes.util.find_library("c")).if_nametoindex
101
127
except (OSError, AttributeError):
 
128
 
102
129
    def if_nametoindex(interface):
103
130
        "Get an interface index the hard way, i.e. using fcntl()"
104
131
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
105
132
        with contextlib.closing(socket.socket()) as s:
106
133
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
 
                                struct.pack(str("16s16x"),
108
 
                                            interface))
109
 
        interface_index = struct.unpack(str("I"),
110
 
                                        ifreq[16:20])[0]
 
134
                                struct.pack(b"16s16x", interface))
 
135
        interface_index = struct.unpack("I", ifreq[16:20])[0]
111
136
        return interface_index
112
137
 
113
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
 
114
155
def initlogger(debug, level=logging.WARNING):
115
156
    """init logger and add loglevel"""
116
 
    
 
157
 
117
158
    global syslogger
118
 
    syslogger = (logging.handlers.SysLogHandler
119
 
                 (facility =
120
 
                  logging.handlers.SysLogHandler.LOG_DAEMON,
121
 
                  address = str("/dev/log")))
 
159
    syslogger = (logging.handlers.SysLogHandler(
 
160
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
 
161
        address="/dev/log"))
122
162
    syslogger.setFormatter(logging.Formatter
123
163
                           ('Mandos [%(process)d]: %(levelname)s:'
124
164
                            ' %(message)s'))
125
165
    logger.addHandler(syslogger)
126
 
    
 
166
 
127
167
    if debug:
128
168
        console = logging.StreamHandler()
129
169
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
141
181
 
142
182
class PGPEngine(object):
143
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
184
 
144
185
    def __init__(self):
145
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
146
198
        self.gnupgargs = ['--batch',
147
 
                          '--home', self.tempdir,
 
199
                          '--homedir', self.tempdir,
148
200
                          '--force-mdc',
149
 
                          '--quiet',
150
 
                          '--no-use-agent']
151
 
    
 
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
 
152
206
    def __enter__(self):
153
207
        return self
154
 
    
 
208
 
155
209
    def __exit__(self, exc_type, exc_value, traceback):
156
210
        self._cleanup()
157
211
        return False
158
 
    
 
212
 
159
213
    def __del__(self):
160
214
        self._cleanup()
161
 
    
 
215
 
162
216
    def _cleanup(self):
163
217
        if self.tempdir is not None:
164
218
            # Delete contents of tempdir
165
219
            for root, dirs, files in os.walk(self.tempdir,
166
 
                                             topdown = False):
 
220
                                             topdown=False):
167
221
                for filename in files:
168
222
                    os.remove(os.path.join(root, filename))
169
223
                for dirname in dirs:
171
225
            # Remove tempdir
172
226
            os.rmdir(self.tempdir)
173
227
            self.tempdir = None
174
 
    
 
228
 
175
229
    def password_encode(self, password):
176
230
        # Passphrase can not be empty and can not contain newlines or
177
231
        # NUL bytes.  So we prefix it and hex encode it.
182
236
                       .replace(b"\n", b"\\n")
183
237
                       .replace(b"\0", b"\\x00"))
184
238
        return encoded
185
 
    
 
239
 
186
240
    def encrypt(self, data, password):
187
241
        passphrase = self.password_encode(password)
188
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
189
 
                                         ) as passfile:
 
242
        with tempfile.NamedTemporaryFile(
 
243
                dir=self.tempdir) as passfile:
190
244
            passfile.write(passphrase)
191
245
            passfile.flush()
192
 
            proc = subprocess.Popen(['gpg', '--symmetric',
 
246
            proc = subprocess.Popen([self.gpg, '--symmetric',
193
247
                                     '--passphrase-file',
194
248
                                     passfile.name]
195
249
                                    + self.gnupgargs,
196
 
                                    stdin = subprocess.PIPE,
197
 
                                    stdout = subprocess.PIPE,
198
 
                                    stderr = subprocess.PIPE)
199
 
            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)
200
254
        if proc.returncode != 0:
201
255
            raise PGPError(err)
202
256
        return ciphertext
203
 
    
 
257
 
204
258
    def decrypt(self, data, password):
205
259
        passphrase = self.password_encode(password)
206
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
207
 
                                         ) as passfile:
 
260
        with tempfile.NamedTemporaryFile(
 
261
                dir=self.tempdir) as passfile:
208
262
            passfile.write(passphrase)
209
263
            passfile.flush()
210
 
            proc = subprocess.Popen(['gpg', '--decrypt',
 
264
            proc = subprocess.Popen([self.gpg, '--decrypt',
211
265
                                     '--passphrase-file',
212
266
                                     passfile.name]
213
267
                                    + self.gnupgargs,
214
 
                                    stdin = subprocess.PIPE,
215
 
                                    stdout = subprocess.PIPE,
216
 
                                    stderr = subprocess.PIPE)
217
 
            decrypted_plaintext, err = proc.communicate(input
218
 
                                                        = data)
 
268
                                    stdin=subprocess.PIPE,
 
269
                                    stdout=subprocess.PIPE,
 
270
                                    stderr=subprocess.PIPE)
 
271
            decrypted_plaintext, err = proc.communicate(input=data)
219
272
        if proc.returncode != 0:
220
273
            raise PGPError(err)
221
274
        return decrypted_plaintext
222
275
 
223
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
 
224
304
class AvahiError(Exception):
225
305
    def __init__(self, value, *args, **kwargs):
226
306
        self.value = value
227
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
228
 
    def __unicode__(self):
229
 
        return unicode(repr(self.value))
 
307
        return super(AvahiError, self).__init__(value, *args,
 
308
                                                **kwargs)
 
309
 
230
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 = unicode(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:
337
431
            self.rename()
338
432
        elif state == avahi.ENTRY_GROUP_FAILURE:
339
433
            logger.critical("Avahi: Error in group state changed %s",
340
 
                            unicode(error))
341
 
            raise AvahiGroupError("State changed: {!s}"
342
 
                                  .format(error))
343
 
    
 
434
                            str(error))
 
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(unicode(getattr(self,
692
 
                                                            attr)))
693
 
                              for attr in self.runtime_expansions }
 
1062
            escaped_attrs = {
 
1063
                attr: re.escape(str(getattr(self, attr)))
 
1064
                for attr in self.runtime_expansions}
694
1065
            try:
695
1066
                command = self.checker_command % escaped_attrs
696
1067
            except TypeError as error:
697
1068
                logger.error('Could not format string "%s"',
698
 
                             self.checker_command, exc_info=error)
699
 
                return True # Try again later
 
1069
                             self.checker_command,
 
1070
                             exc_info=error)
 
1071
                return True     # Try again later
700
1072
            self.current_checker_command = command
701
 
            try:
702
 
                logger.info("Starting checker %r for %s",
703
 
                            command, self.name)
704
 
                # We don't need to redirect stdout and stderr, since
705
 
                # in normal mode, that is already done by daemon(),
706
 
                # and in debug mode we don't want to.  (Stdin is
707
 
                # always replaced by /dev/null.)
708
 
                # The exception is when not debugging but nevertheless
709
 
                # running in the foreground; use the previously
710
 
                # created wnull.
711
 
                popen_args = {}
712
 
                if (not self.server_settings["debug"]
713
 
                    and self.server_settings["foreground"]):
714
 
                    popen_args.update({"stdout": wnull,
715
 
                                       "stderr": wnull })
716
 
                self.checker = subprocess.Popen(command,
717
 
                                                close_fds=True,
718
 
                                                shell=True, cwd="/",
719
 
                                                **popen_args)
720
 
            except OSError as error:
721
 
                logger.error("Failed to start subprocess",
722
 
                             exc_info=error)
723
 
                return True
724
 
            self.checker_callback_tag = (gobject.child_watch_add
725
 
                                         (self.checker.pid,
726
 
                                          self.checker_callback,
727
 
                                          data=command))
728
 
            # The checker may have completed before the gobject
729
 
            # watch was added.  Check for this.
730
 
            try:
731
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
732
 
            except OSError as error:
733
 
                if error.errno == errno.ECHILD:
734
 
                    # This should never happen
735
 
                    logger.error("Child process vanished",
736
 
                                 exc_info=error)
737
 
                    return True
738
 
                raise
739
 
            if pid:
740
 
                gobject.source_remove(self.checker_callback_tag)
741
 
                self.checker_callback(pid, status, command)
742
 
        # 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
743
1099
        return True
744
 
    
 
1100
 
745
1101
    def stop_checker(self):
746
1102
        """Force the checker process, if any, to stop."""
747
1103
        if self.checker_callback_tag:
748
 
            gobject.source_remove(self.checker_callback_tag)
 
1104
            GLib.source_remove(self.checker_callback_tag)
749
1105
            self.checker_callback_tag = None
750
1106
        if getattr(self, "checker", None) is None:
751
1107
            return
752
1108
        logger.debug("Stopping checker for %(name)s", vars(self))
753
 
        try:
754
 
            self.checker.terminate()
755
 
            #time.sleep(0.5)
756
 
            #if self.checker.poll() is None:
757
 
            #    self.checker.kill()
758
 
        except OSError as error:
759
 
            if error.errno != errno.ESRCH: # No such process
760
 
                raise
 
1109
        self.checker.terminate()
761
1110
        self.checker = None
762
1111
 
763
1112
 
764
 
def dbus_service_property(dbus_interface, signature="v",
765
 
                          access="readwrite", byte_arrays=False):
 
1113
def dbus_service_property(dbus_interface,
 
1114
                          signature="v",
 
1115
                          access="readwrite",
 
1116
                          byte_arrays=False):
766
1117
    """Decorators for marking methods of a DBusObjectWithProperties to
767
1118
    become properties on the D-Bus.
768
 
    
 
1119
 
769
1120
    The decorated method will be called with no arguments by "Get"
770
1121
    and with one argument by "Set".
771
 
    
 
1122
 
772
1123
    The parameters, where they are supported, are the same as
773
1124
    dbus.service.method, except there is only "signature", since the
774
1125
    type from Get() and the type sent to Set() is the same.
778
1129
    if byte_arrays and signature != "ay":
779
1130
        raise ValueError("Byte arrays not supported for non-'ay'"
780
1131
                         " signature {!r}".format(signature))
 
1132
 
781
1133
    def decorator(func):
782
1134
        func._dbus_is_property = True
783
1135
        func._dbus_interface = dbus_interface
786
1138
        func._dbus_name = func.__name__
787
1139
        if func._dbus_name.endswith("_dbus_property"):
788
1140
            func._dbus_name = func._dbus_name[:-14]
789
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
1141
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
790
1142
        return func
 
1143
 
791
1144
    return decorator
792
1145
 
793
1146
 
794
1147
def dbus_interface_annotations(dbus_interface):
795
1148
    """Decorator for marking functions returning interface annotations
796
 
    
 
1149
 
797
1150
    Usage:
798
 
    
 
1151
 
799
1152
    @dbus_interface_annotations("org.example.Interface")
800
1153
    def _foo(self):  # Function name does not matter
801
1154
        return {"org.freedesktop.DBus.Deprecated": "true",
802
1155
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
803
1156
                    "false"}
804
1157
    """
 
1158
 
805
1159
    def decorator(func):
806
1160
        func._dbus_is_interface = True
807
1161
        func._dbus_interface = dbus_interface
808
1162
        func._dbus_name = dbus_interface
809
1163
        return func
 
1164
 
810
1165
    return decorator
811
1166
 
812
1167
 
813
1168
def dbus_annotations(annotations):
814
1169
    """Decorator to annotate D-Bus methods, signals or properties
815
1170
    Usage:
816
 
    
 
1171
 
 
1172
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
1173
                       "org.freedesktop.DBus.Property."
 
1174
                       "EmitsChangedSignal": "false"})
817
1175
    @dbus_service_property("org.example.Interface", signature="b",
818
1176
                           access="r")
819
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
820
 
                        "org.freedesktop.DBus.Property."
821
 
                        "EmitsChangedSignal": "false"})
822
1177
    def Property_dbus_property(self):
823
1178
        return dbus.Boolean(False)
 
1179
 
 
1180
    See also the DBusObjectWithAnnotations class.
824
1181
    """
 
1182
 
825
1183
    def decorator(func):
826
1184
        func._dbus_annotations = annotations
827
1185
        return func
 
1186
 
828
1187
    return decorator
829
1188
 
830
1189
 
831
1190
class DBusPropertyException(dbus.exceptions.DBusException):
832
1191
    """A base class for D-Bus property-related exceptions
833
1192
    """
834
 
    def __unicode__(self):
835
 
        return unicode(str(self))
 
1193
    pass
836
1194
 
837
1195
 
838
1196
class DBusPropertyAccessException(DBusPropertyException):
847
1205
    pass
848
1206
 
849
1207
 
850
 
class DBusObjectWithProperties(dbus.service.Object):
851
 
    """A D-Bus object with properties.
852
 
    
853
 
    Classes inheriting from this can use the dbus_service_property
854
 
    decorator to expose methods as D-Bus properties.  It exposes the
855
 
    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.
856
1213
    """
857
 
    
 
1214
 
858
1215
    @staticmethod
859
1216
    def _is_dbus_thing(thing):
860
1217
        """Returns a function testing if an attribute is a D-Bus thing
861
 
        
 
1218
 
862
1219
        If called like _is_dbus_thing("method") it returns a function
863
1220
        suitable for use as predicate to inspect.getmembers().
864
1221
        """
865
1222
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
866
1223
                                   False)
867
 
    
 
1224
 
868
1225
    def _get_all_dbus_things(self, thing):
869
1226
        """Returns a generator of (name, attribute) pairs
870
1227
        """
871
 
        return ((getattr(athing.__get__(self), "_dbus_name",
872
 
                         name),
 
1228
        return ((getattr(athing.__get__(self), "_dbus_name", name),
873
1229
                 athing.__get__(self))
874
1230
                for cls in self.__class__.__mro__
875
1231
                for name, athing in
876
 
                inspect.getmembers(cls,
877
 
                                   self._is_dbus_thing(thing)))
878
 
    
 
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
 
879
1305
    def _get_dbus_property(self, interface_name, property_name):
880
1306
        """Returns a bound method if one exists which is a D-Bus
881
1307
        property with the specified name and interface.
882
1308
        """
883
 
        for cls in  self.__class__.__mro__:
884
 
            for name, value in (inspect.getmembers
885
 
                                (cls,
886
 
                                 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")):
887
1312
                if (value._dbus_name == property_name
888
1313
                    and value._dbus_interface == interface_name):
889
1314
                    return value.__get__(self)
890
 
        
 
1315
 
891
1316
        # No such property
892
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
893
 
                                   + interface_name + "."
894
 
                                   + property_name)
895
 
    
896
 
    @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",
897
1331
                         out_signature="v")
898
1332
    def Get(self, interface_name, property_name):
899
1333
        """Standard D-Bus property Get() method, see D-Bus standard.
905
1339
        if not hasattr(value, "variant_level"):
906
1340
            return value
907
1341
        return type(value)(value, variant_level=value.variant_level+1)
908
 
    
 
1342
 
909
1343
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
910
1344
    def Set(self, interface_name, property_name, value):
911
1345
        """Standard D-Bus property Set() method, see D-Bus standard.
923
1357
            value = dbus.ByteArray(b''.join(chr(byte)
924
1358
                                            for byte in value))
925
1359
        prop(value)
926
 
    
927
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1360
 
 
1361
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1362
                         in_signature="s",
928
1363
                         out_signature="a{sv}")
929
1364
    def GetAll(self, interface_name):
930
1365
        """Standard D-Bus property GetAll() method, see D-Bus
931
1366
        standard.
932
 
        
 
1367
 
933
1368
        Note: Will not include properties with access="write".
934
1369
        """
935
1370
        properties = {}
945
1380
            if not hasattr(value, "variant_level"):
946
1381
                properties[name] = value
947
1382
                continue
948
 
            properties[name] = type(value)(value, variant_level=
949
 
                                           value.variant_level+1)
 
1383
            properties[name] = type(value)(
 
1384
                value, variant_level=value.variant_level + 1)
950
1385
        return dbus.Dictionary(properties, signature="sv")
951
 
    
 
1386
 
 
1387
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
1388
    def PropertiesChanged(self, interface_name, changed_properties,
 
1389
                          invalidated_properties):
 
1390
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
1391
        standard.
 
1392
        """
 
1393
        pass
 
1394
 
952
1395
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
953
1396
                         out_signature="s",
954
1397
                         path_keyword='object_path',
955
1398
                         connection_keyword='connection')
956
1399
    def Introspect(self, object_path, connection):
957
1400
        """Overloading of standard D-Bus method.
958
 
        
 
1401
 
959
1402
        Inserts property tags and interface annotation tags.
960
1403
        """
961
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
962
 
                                                   connection)
 
1404
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1405
                                                         object_path,
 
1406
                                                         connection)
963
1407
        try:
964
1408
            document = xml.dom.minidom.parseString(xmlstring)
 
1409
 
965
1410
            def make_tag(document, name, prop):
966
1411
                e = document.createElement("property")
967
1412
                e.setAttribute("name", name)
968
1413
                e.setAttribute("type", prop._dbus_signature)
969
1414
                e.setAttribute("access", prop._dbus_access)
970
1415
                return e
 
1416
 
971
1417
            for if_tag in document.getElementsByTagName("interface"):
972
1418
                # Add property tags
973
1419
                for tag in (make_tag(document, name, prop)
976
1422
                            if prop._dbus_interface
977
1423
                            == if_tag.getAttribute("name")):
978
1424
                    if_tag.appendChild(tag)
979
 
                # Add annotation tags
980
 
                for typ in ("method", "signal", "property"):
981
 
                    for tag in if_tag.getElementsByTagName(typ):
982
 
                        annots = dict()
983
 
                        for name, prop in (self.
984
 
                                           _get_all_dbus_things(typ)):
985
 
                            if (name == tag.getAttribute("name")
986
 
                                and prop._dbus_interface
987
 
                                == if_tag.getAttribute("name")):
988
 
                                annots.update(getattr
989
 
                                              (prop,
990
 
                                               "_dbus_annotations",
991
 
                                               {}))
992
 
                        for name, value in annots.items():
993
 
                            ann_tag = document.createElement(
994
 
                                "annotation")
995
 
                            ann_tag.setAttribute("name", name)
996
 
                            ann_tag.setAttribute("value", value)
997
 
                            tag.appendChild(ann_tag)
998
 
                # Add interface annotation tags
999
 
                for annotation, value in dict(
1000
 
                    itertools.chain.from_iterable(
1001
 
                        annotations().items()
1002
 
                        for name, annotations in
1003
 
                        self._get_all_dbus_things("interface")
1004
 
                        if name == if_tag.getAttribute("name")
1005
 
                        )).items():
1006
 
                    ann_tag = document.createElement("annotation")
1007
 
                    ann_tag.setAttribute("name", annotation)
1008
 
                    ann_tag.setAttribute("value", value)
1009
 
                    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)
1010
1441
                # Add the names to the return values for the
1011
1442
                # "org.freedesktop.DBus.Properties" methods
1012
1443
                if (if_tag.getAttribute("name")
1031
1462
        return xmlstring
1032
1463
 
1033
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
 
1034
1536
def datetime_to_dbus(dt, variant_level=0):
1035
1537
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1036
1538
    if dt is None:
1037
 
        return dbus.String("", variant_level = variant_level)
1038
 
    return dbus.String(dt.isoformat(),
1039
 
                       variant_level=variant_level)
 
1539
        return dbus.String("", variant_level=variant_level)
 
1540
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1040
1541
 
1041
1542
 
1042
1543
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1044
1545
    dbus.service.Object, it will add alternate D-Bus attributes with
1045
1546
    interface names according to the "alt_interface_names" mapping.
1046
1547
    Usage:
1047
 
    
 
1548
 
1048
1549
    @alternate_dbus_interfaces({"org.example.Interface":
1049
1550
                                    "net.example.AlternateInterface"})
1050
1551
    class SampleDBusObject(dbus.service.Object):
1051
1552
        @dbus.service.method("org.example.Interface")
1052
1553
        def SampleDBusMethod():
1053
1554
            pass
1054
 
    
 
1555
 
1055
1556
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1056
1557
    reachable via two interfaces: "org.example.Interface" and
1057
1558
    "net.example.AlternateInterface", the latter of which will have
1058
1559
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1059
1560
    "true", unless "deprecate" is passed with a False value.
1060
 
    
 
1561
 
1061
1562
    This works for methods and signals, and also for D-Bus properties
1062
1563
    (from DBusObjectWithProperties) and interfaces (from the
1063
1564
    dbus_interface_annotations decorator).
1064
1565
    """
 
1566
 
1065
1567
    def wrapper(cls):
1066
1568
        for orig_interface_name, alt_interface_name in (
1067
 
            alt_interface_names.items()):
 
1569
                alt_interface_names.items()):
1068
1570
            attr = {}
1069
1571
            interface_names = set()
1070
1572
            # Go though all attributes of the class
1072
1574
                # Ignore non-D-Bus attributes, and D-Bus attributes
1073
1575
                # with the wrong interface name
1074
1576
                if (not hasattr(attribute, "_dbus_interface")
1075
 
                    or not attribute._dbus_interface
1076
 
                    .startswith(orig_interface_name)):
 
1577
                    or not attribute._dbus_interface.startswith(
 
1578
                        orig_interface_name)):
1077
1579
                    continue
1078
1580
                # Create an alternate D-Bus interface name based on
1079
1581
                # the current name
1080
 
                alt_interface = (attribute._dbus_interface
1081
 
                                 .replace(orig_interface_name,
1082
 
                                          alt_interface_name))
 
1582
                alt_interface = attribute._dbus_interface.replace(
 
1583
                    orig_interface_name, alt_interface_name)
1083
1584
                interface_names.add(alt_interface)
1084
1585
                # Is this a D-Bus signal?
1085
1586
                if getattr(attribute, "_dbus_is_signal", False):
1086
1587
                    # Extract the original non-method undecorated
1087
1588
                    # function by black magic
1088
 
                    nonmethod_func = (dict(
 
1589
                    if sys.version_info.major == 2:
 
1590
                        nonmethod_func = (dict(
1089
1591
                            zip(attribute.func_code.co_freevars,
1090
 
                                attribute.__closure__))["func"]
1091
 
                                      .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)
1092
1599
                    # Create a new, but exactly alike, function
1093
1600
                    # object, and decorate it to be a new D-Bus signal
1094
1601
                    # with the alternate D-Bus interface name
1095
 
                    new_function = (dbus.service.signal
1096
 
                                    (alt_interface,
1097
 
                                     attribute._dbus_signature)
1098
 
                                    (types.FunctionType(
1099
 
                                nonmethod_func.func_code,
1100
 
                                nonmethod_func.func_globals,
1101
 
                                nonmethod_func.func_name,
1102
 
                                nonmethod_func.func_defaults,
1103
 
                                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))
1104
1606
                    # Copy annotations, if any
1105
1607
                    try:
1106
 
                        new_function._dbus_annotations = (
1107
 
                            dict(attribute._dbus_annotations))
 
1608
                        new_function._dbus_annotations = dict(
 
1609
                            attribute._dbus_annotations)
1108
1610
                    except AttributeError:
1109
1611
                        pass
 
1612
 
1110
1613
                    # Define a creator of a function to call both the
1111
1614
                    # original and alternate functions, so both the
1112
1615
                    # original and alternate signals gets sent when
1115
1618
                        """This function is a scope container to pass
1116
1619
                        func1 and func2 to the "call_both" function
1117
1620
                        outside of its arguments"""
 
1621
 
 
1622
                        @functools.wraps(func2)
1118
1623
                        def call_both(*args, **kwargs):
1119
1624
                            """This function will emit two D-Bus
1120
1625
                            signals by calling func1 and func2"""
1121
1626
                            func1(*args, **kwargs)
1122
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
 
1123
1634
                        return call_both
1124
1635
                    # Create the "call_both" function and add it to
1125
1636
                    # the class
1130
1641
                    # object.  Decorate it to be a new D-Bus method
1131
1642
                    # with the alternate D-Bus interface name.  Add it
1132
1643
                    # to the class.
1133
 
                    attr[attrname] = (dbus.service.method
1134
 
                                      (alt_interface,
1135
 
                                       attribute._dbus_in_signature,
1136
 
                                       attribute._dbus_out_signature)
1137
 
                                      (types.FunctionType
1138
 
                                       (attribute.func_code,
1139
 
                                        attribute.func_globals,
1140
 
                                        attribute.func_name,
1141
 
                                        attribute.func_defaults,
1142
 
                                        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)))
1143
1650
                    # Copy annotations, if any
1144
1651
                    try:
1145
 
                        attr[attrname]._dbus_annotations = (
1146
 
                            dict(attribute._dbus_annotations))
 
1652
                        attr[attrname]._dbus_annotations = dict(
 
1653
                            attribute._dbus_annotations)
1147
1654
                    except AttributeError:
1148
1655
                        pass
1149
1656
                # Is this a D-Bus property?
1152
1659
                    # object, and decorate it to be a new D-Bus
1153
1660
                    # property with the alternate D-Bus interface
1154
1661
                    # name.  Add it to the class.
1155
 
                    attr[attrname] = (dbus_service_property
1156
 
                                      (alt_interface,
1157
 
                                       attribute._dbus_signature,
1158
 
                                       attribute._dbus_access,
1159
 
                                       attribute
1160
 
                                       ._dbus_get_args_options
1161
 
                                       ["byte_arrays"])
1162
 
                                      (types.FunctionType
1163
 
                                       (attribute.func_code,
1164
 
                                        attribute.func_globals,
1165
 
                                        attribute.func_name,
1166
 
                                        attribute.func_defaults,
1167
 
                                        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)))
1168
1668
                    # Copy annotations, if any
1169
1669
                    try:
1170
 
                        attr[attrname]._dbus_annotations = (
1171
 
                            dict(attribute._dbus_annotations))
 
1670
                        attr[attrname]._dbus_annotations = dict(
 
1671
                            attribute._dbus_annotations)
1172
1672
                    except AttributeError:
1173
1673
                        pass
1174
1674
                # Is this a D-Bus interface?
1177
1677
                    # object.  Decorate it to be a new D-Bus interface
1178
1678
                    # with the alternate D-Bus interface name.  Add it
1179
1679
                    # to the class.
1180
 
                    attr[attrname] = (dbus_interface_annotations
1181
 
                                      (alt_interface)
1182
 
                                      (types.FunctionType
1183
 
                                       (attribute.func_code,
1184
 
                                        attribute.func_globals,
1185
 
                                        attribute.func_name,
1186
 
                                        attribute.func_defaults,
1187
 
                                        attribute.func_closure)))
 
1680
                    attr[attrname] = (
 
1681
                        dbus_interface_annotations(alt_interface)
 
1682
                        (copy_function(attribute)))
1188
1683
            if deprecate:
1189
1684
                # Deprecate all alternate interfaces
1190
 
                iname="_AlternateDBusNames_interface_annotation{}"
 
1685
                iname = "_AlternateDBusNames_interface_annotation{}"
1191
1686
                for interface_name in interface_names:
 
1687
 
1192
1688
                    @dbus_interface_annotations(interface_name)
1193
1689
                    def func(self):
1194
 
                        return { "org.freedesktop.DBus.Deprecated":
1195
 
                                     "true" }
 
1690
                        return {"org.freedesktop.DBus.Deprecated":
 
1691
                                "true"}
1196
1692
                    # Find an unused name
1197
1693
                    for aname in (iname.format(i)
1198
1694
                                  for i in itertools.count()):
1202
1698
            if interface_names:
1203
1699
                # Replace the class with a new subclass of it with
1204
1700
                # methods, signals, etc. as created above.
1205
 
                cls = type(b"{}Alternate".format(cls.__name__),
1206
 
                           (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)
1207
1707
        return cls
 
1708
 
1208
1709
    return wrapper
1209
1710
 
1210
1711
 
1211
1712
@alternate_dbus_interfaces({"se.recompile.Mandos":
1212
 
                                "se.bsnet.fukt.Mandos"})
 
1713
                            "se.bsnet.fukt.Mandos"})
1213
1714
class ClientDBus(Client, DBusObjectWithProperties):
1214
1715
    """A Client class using D-Bus
1215
 
    
 
1716
 
1216
1717
    Attributes:
1217
1718
    dbus_object_path: dbus.ObjectPath
1218
1719
    bus: dbus.SystemBus()
1219
1720
    """
1220
 
    
 
1721
 
1221
1722
    runtime_expansions = (Client.runtime_expansions
1222
 
                          + ("dbus_object_path",))
1223
 
    
 
1723
                          + ("dbus_object_path", ))
 
1724
 
 
1725
    _interface = "se.recompile.Mandos.Client"
 
1726
 
1224
1727
    # dbus.service.Object doesn't use super(), so we can't either.
1225
 
    
1226
 
    def __init__(self, bus = None, *args, **kwargs):
 
1728
 
 
1729
    def __init__(self, bus=None, *args, **kwargs):
1227
1730
        self.bus = bus
1228
1731
        Client.__init__(self, *args, **kwargs)
1229
1732
        # Only now, when this client is initialized, can it show up on
1230
1733
        # the D-Bus
1231
 
        client_object_name = unicode(self.name).translate(
 
1734
        client_object_name = str(self.name).translate(
1232
1735
            {ord("."): ord("_"),
1233
1736
             ord("-"): ord("_")})
1234
 
        self.dbus_object_path = (dbus.ObjectPath
1235
 
                                 ("/clients/" + client_object_name))
 
1737
        self.dbus_object_path = dbus.ObjectPath(
 
1738
            "/clients/" + client_object_name)
1236
1739
        DBusObjectWithProperties.__init__(self, self.bus,
1237
1740
                                          self.dbus_object_path)
1238
 
    
1239
 
    def notifychangeproperty(transform_func,
1240
 
                             dbus_name, type_func=lambda x: x,
1241
 
                             variant_level=1):
 
1741
 
 
1742
    def notifychangeproperty(transform_func, dbus_name,
 
1743
                             type_func=lambda x: x,
 
1744
                             variant_level=1,
 
1745
                             invalidate_only=False,
 
1746
                             _interface=_interface):
1242
1747
        """ Modify a variable so that it's a property which announces
1243
1748
        its changes to DBus.
1244
 
        
 
1749
 
1245
1750
        transform_fun: Function that takes a value and a variant_level
1246
1751
                       and transforms it to a D-Bus type.
1247
1752
        dbus_name: D-Bus name of the variable
1250
1755
        variant_level: D-Bus variant level.  Default: 1
1251
1756
        """
1252
1757
        attrname = "_{}".format(dbus_name)
 
1758
 
1253
1759
        def setter(self, value):
1254
1760
            if hasattr(self, "dbus_object_path"):
1255
1761
                if (not hasattr(self, attrname) or
1256
1762
                    type_func(getattr(self, attrname, None))
1257
1763
                    != type_func(value)):
1258
 
                    dbus_value = transform_func(type_func(value),
1259
 
                                                variant_level
1260
 
                                                =variant_level)
1261
 
                    self.PropertyChanged(dbus.String(dbus_name),
1262
 
                                         dbus_value)
 
1764
                    if invalidate_only:
 
1765
                        self.PropertiesChanged(
 
1766
                            _interface, dbus.Dictionary(),
 
1767
                            dbus.Array((dbus_name, )))
 
1768
                    else:
 
1769
                        dbus_value = transform_func(
 
1770
                            type_func(value),
 
1771
                            variant_level=variant_level)
 
1772
                        self.PropertyChanged(dbus.String(dbus_name),
 
1773
                                             dbus_value)
 
1774
                        self.PropertiesChanged(
 
1775
                            _interface,
 
1776
                            dbus.Dictionary({dbus.String(dbus_name):
 
1777
                                             dbus_value}),
 
1778
                            dbus.Array())
1263
1779
            setattr(self, attrname, value)
1264
 
        
 
1780
 
1265
1781
        return property(lambda self: getattr(self, attrname), setter)
1266
 
    
 
1782
 
1267
1783
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1268
1784
    approvals_pending = notifychangeproperty(dbus.Boolean,
1269
1785
                                             "ApprovalPending",
1270
 
                                             type_func = bool)
 
1786
                                             type_func=bool)
1271
1787
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1272
1788
    last_enabled = notifychangeproperty(datetime_to_dbus,
1273
1789
                                        "LastEnabled")
1274
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1275
 
                                   type_func = lambda checker:
1276
 
                                       checker is not None)
 
1790
    checker = notifychangeproperty(
 
1791
        dbus.Boolean, "CheckerRunning",
 
1792
        type_func=lambda checker: checker is not None)
1277
1793
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1278
1794
                                           "LastCheckedOK")
1279
1795
    last_checker_status = notifychangeproperty(dbus.Int16,
1282
1798
        datetime_to_dbus, "LastApprovalRequest")
1283
1799
    approved_by_default = notifychangeproperty(dbus.Boolean,
1284
1800
                                               "ApprovedByDefault")
1285
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1286
 
                                          "ApprovalDelay",
1287
 
                                          type_func =
1288
 
                                          lambda td: td.total_seconds()
1289
 
                                          * 1000)
 
1801
    approval_delay = notifychangeproperty(
 
1802
        dbus.UInt64, "ApprovalDelay",
 
1803
        type_func=lambda td: td.total_seconds() * 1000)
1290
1804
    approval_duration = notifychangeproperty(
1291
1805
        dbus.UInt64, "ApprovalDuration",
1292
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1806
        type_func=lambda td: td.total_seconds() * 1000)
1293
1807
    host = notifychangeproperty(dbus.String, "Host")
1294
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1295
 
                                   type_func = lambda td:
1296
 
                                       td.total_seconds() * 1000)
 
1808
    timeout = notifychangeproperty(
 
1809
        dbus.UInt64, "Timeout",
 
1810
        type_func=lambda td: td.total_seconds() * 1000)
1297
1811
    extended_timeout = notifychangeproperty(
1298
1812
        dbus.UInt64, "ExtendedTimeout",
1299
 
        type_func = lambda td: td.total_seconds() * 1000)
1300
 
    interval = notifychangeproperty(dbus.UInt64,
1301
 
                                    "Interval",
1302
 
                                    type_func =
1303
 
                                    lambda td: td.total_seconds()
1304
 
                                    * 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)
1305
1817
    checker_command = notifychangeproperty(dbus.String, "Checker")
1306
 
    
 
1818
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1819
                                  invalidate_only=True)
 
1820
 
1307
1821
    del notifychangeproperty
1308
 
    
 
1822
 
1309
1823
    def __del__(self, *args, **kwargs):
1310
1824
        try:
1311
1825
            self.remove_from_connection()
1314
1828
        if hasattr(DBusObjectWithProperties, "__del__"):
1315
1829
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1316
1830
        Client.__del__(self, *args, **kwargs)
1317
 
    
1318
 
    def checker_callback(self, pid, condition, command,
1319
 
                         *args, **kwargs):
1320
 
        self.checker_callback_tag = None
1321
 
        self.checker = None
1322
 
        if os.WIFEXITED(condition):
1323
 
            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:
1324
1839
            # Emit D-Bus signal
1325
1840
            self.CheckerCompleted(dbus.Int16(exitstatus),
1326
 
                                  dbus.Int64(condition),
 
1841
                                  # This is specific to GNU libC
 
1842
                                  dbus.Int64(exitstatus << 8),
1327
1843
                                  dbus.String(command))
1328
1844
        else:
1329
1845
            # Emit D-Bus signal
1330
1846
            self.CheckerCompleted(dbus.Int16(-1),
1331
 
                                  dbus.Int64(condition),
 
1847
                                  dbus.Int64(
 
1848
                                      # This is specific to GNU libC
 
1849
                                      (exitstatus << 8)
 
1850
                                      | self.last_checker_signal),
1332
1851
                                  dbus.String(command))
1333
 
        
1334
 
        return Client.checker_callback(self, pid, condition, command,
1335
 
                                       *args, **kwargs)
1336
 
    
 
1852
        return ret
 
1853
 
1337
1854
    def start_checker(self, *args, **kwargs):
1338
1855
        old_checker_pid = getattr(self.checker, "pid", None)
1339
1856
        r = Client.start_checker(self, *args, **kwargs)
1343
1860
            # Emit D-Bus signal
1344
1861
            self.CheckerStarted(self.current_checker_command)
1345
1862
        return r
1346
 
    
 
1863
 
1347
1864
    def _reset_approved(self):
1348
1865
        self.approved = None
1349
1866
        return False
1350
 
    
 
1867
 
1351
1868
    def approve(self, value=True):
1352
1869
        self.approved = value
1353
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1354
 
                                * 1000), self._reset_approved)
 
1870
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1871
                             * 1000), self._reset_approved)
1355
1872
        self.send_changedstate()
1356
 
    
1357
 
    ## D-Bus methods, signals & properties
1358
 
    _interface = "se.recompile.Mandos.Client"
1359
 
    
1360
 
    ## Interfaces
1361
 
    
1362
 
    @dbus_interface_annotations(_interface)
1363
 
    def _foo(self):
1364
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1365
 
                     "false"}
1366
 
    
1367
 
    ## Signals
1368
 
    
 
1873
 
 
1874
    #  D-Bus methods, signals & properties
 
1875
 
 
1876
    #  Interfaces
 
1877
 
 
1878
    #  Signals
 
1879
 
1369
1880
    # CheckerCompleted - signal
1370
1881
    @dbus.service.signal(_interface, signature="nxs")
1371
1882
    def CheckerCompleted(self, exitcode, waitstatus, command):
1372
1883
        "D-Bus signal"
1373
1884
        pass
1374
 
    
 
1885
 
1375
1886
    # CheckerStarted - signal
1376
1887
    @dbus.service.signal(_interface, signature="s")
1377
1888
    def CheckerStarted(self, command):
1378
1889
        "D-Bus signal"
1379
1890
        pass
1380
 
    
 
1891
 
1381
1892
    # PropertyChanged - signal
 
1893
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1382
1894
    @dbus.service.signal(_interface, signature="sv")
1383
1895
    def PropertyChanged(self, property, value):
1384
1896
        "D-Bus signal"
1385
1897
        pass
1386
 
    
 
1898
 
1387
1899
    # GotSecret - signal
1388
1900
    @dbus.service.signal(_interface)
1389
1901
    def GotSecret(self):
1392
1904
        server to mandos-client
1393
1905
        """
1394
1906
        pass
1395
 
    
 
1907
 
1396
1908
    # Rejected - signal
1397
1909
    @dbus.service.signal(_interface, signature="s")
1398
1910
    def Rejected(self, reason):
1399
1911
        "D-Bus signal"
1400
1912
        pass
1401
 
    
 
1913
 
1402
1914
    # NeedApproval - signal
1403
1915
    @dbus.service.signal(_interface, signature="tb")
1404
1916
    def NeedApproval(self, timeout, default):
1405
1917
        "D-Bus signal"
1406
1918
        return self.need_approval()
1407
 
    
1408
 
    ## Methods
1409
 
    
 
1919
 
 
1920
    #  Methods
 
1921
 
1410
1922
    # Approve - method
1411
1923
    @dbus.service.method(_interface, in_signature="b")
1412
1924
    def Approve(self, value):
1413
1925
        self.approve(value)
1414
 
    
 
1926
 
1415
1927
    # CheckedOK - method
1416
1928
    @dbus.service.method(_interface)
1417
1929
    def CheckedOK(self):
1418
1930
        self.checked_ok()
1419
 
    
 
1931
 
1420
1932
    # Enable - method
 
1933
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1421
1934
    @dbus.service.method(_interface)
1422
1935
    def Enable(self):
1423
1936
        "D-Bus method"
1424
1937
        self.enable()
1425
 
    
 
1938
 
1426
1939
    # StartChecker - method
 
1940
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1427
1941
    @dbus.service.method(_interface)
1428
1942
    def StartChecker(self):
1429
1943
        "D-Bus method"
1430
1944
        self.start_checker()
1431
 
    
 
1945
 
1432
1946
    # Disable - method
 
1947
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1433
1948
    @dbus.service.method(_interface)
1434
1949
    def Disable(self):
1435
1950
        "D-Bus method"
1436
1951
        self.disable()
1437
 
    
 
1952
 
1438
1953
    # StopChecker - method
 
1954
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1439
1955
    @dbus.service.method(_interface)
1440
1956
    def StopChecker(self):
1441
1957
        self.stop_checker()
1442
 
    
1443
 
    ## Properties
1444
 
    
 
1958
 
 
1959
    #  Properties
 
1960
 
1445
1961
    # ApprovalPending - property
1446
1962
    @dbus_service_property(_interface, signature="b", access="read")
1447
1963
    def ApprovalPending_dbus_property(self):
1448
1964
        return dbus.Boolean(bool(self.approvals_pending))
1449
 
    
 
1965
 
1450
1966
    # ApprovedByDefault - property
1451
 
    @dbus_service_property(_interface, signature="b",
 
1967
    @dbus_service_property(_interface,
 
1968
                           signature="b",
1452
1969
                           access="readwrite")
1453
1970
    def ApprovedByDefault_dbus_property(self, value=None):
1454
1971
        if value is None:       # get
1455
1972
            return dbus.Boolean(self.approved_by_default)
1456
1973
        self.approved_by_default = bool(value)
1457
 
    
 
1974
 
1458
1975
    # ApprovalDelay - property
1459
 
    @dbus_service_property(_interface, signature="t",
 
1976
    @dbus_service_property(_interface,
 
1977
                           signature="t",
1460
1978
                           access="readwrite")
1461
1979
    def ApprovalDelay_dbus_property(self, value=None):
1462
1980
        if value is None:       # get
1463
1981
            return dbus.UInt64(self.approval_delay.total_seconds()
1464
1982
                               * 1000)
1465
1983
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1466
 
    
 
1984
 
1467
1985
    # ApprovalDuration - property
1468
 
    @dbus_service_property(_interface, signature="t",
 
1986
    @dbus_service_property(_interface,
 
1987
                           signature="t",
1469
1988
                           access="readwrite")
1470
1989
    def ApprovalDuration_dbus_property(self, value=None):
1471
1990
        if value is None:       # get
1472
1991
            return dbus.UInt64(self.approval_duration.total_seconds()
1473
1992
                               * 1000)
1474
1993
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1475
 
    
 
1994
 
1476
1995
    # Name - property
 
1996
    @dbus_annotations(
 
1997
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1477
1998
    @dbus_service_property(_interface, signature="s", access="read")
1478
1999
    def Name_dbus_property(self):
1479
2000
        return dbus.String(self.name)
1480
 
    
 
2001
 
1481
2002
    # Fingerprint - property
 
2003
    @dbus_annotations(
 
2004
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1482
2005
    @dbus_service_property(_interface, signature="s", access="read")
1483
2006
    def Fingerprint_dbus_property(self):
1484
2007
        return dbus.String(self.fingerprint)
1485
 
    
 
2008
 
1486
2009
    # Host - property
1487
 
    @dbus_service_property(_interface, signature="s",
 
2010
    @dbus_service_property(_interface,
 
2011
                           signature="s",
1488
2012
                           access="readwrite")
1489
2013
    def Host_dbus_property(self, value=None):
1490
2014
        if value is None:       # get
1491
2015
            return dbus.String(self.host)
1492
 
        self.host = unicode(value)
1493
 
    
 
2016
        self.host = str(value)
 
2017
 
1494
2018
    # Created - property
 
2019
    @dbus_annotations(
 
2020
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1495
2021
    @dbus_service_property(_interface, signature="s", access="read")
1496
2022
    def Created_dbus_property(self):
1497
2023
        return datetime_to_dbus(self.created)
1498
 
    
 
2024
 
1499
2025
    # LastEnabled - property
1500
2026
    @dbus_service_property(_interface, signature="s", access="read")
1501
2027
    def LastEnabled_dbus_property(self):
1502
2028
        return datetime_to_dbus(self.last_enabled)
1503
 
    
 
2029
 
1504
2030
    # Enabled - property
1505
 
    @dbus_service_property(_interface, signature="b",
 
2031
    @dbus_service_property(_interface,
 
2032
                           signature="b",
1506
2033
                           access="readwrite")
1507
2034
    def Enabled_dbus_property(self, value=None):
1508
2035
        if value is None:       # get
1511
2038
            self.enable()
1512
2039
        else:
1513
2040
            self.disable()
1514
 
    
 
2041
 
1515
2042
    # LastCheckedOK - property
1516
 
    @dbus_service_property(_interface, signature="s",
 
2043
    @dbus_service_property(_interface,
 
2044
                           signature="s",
1517
2045
                           access="readwrite")
1518
2046
    def LastCheckedOK_dbus_property(self, value=None):
1519
2047
        if value is not None:
1520
2048
            self.checked_ok()
1521
2049
            return
1522
2050
        return datetime_to_dbus(self.last_checked_ok)
1523
 
    
 
2051
 
1524
2052
    # LastCheckerStatus - property
1525
 
    @dbus_service_property(_interface, signature="n",
1526
 
                           access="read")
 
2053
    @dbus_service_property(_interface, signature="n", access="read")
1527
2054
    def LastCheckerStatus_dbus_property(self):
1528
2055
        return dbus.Int16(self.last_checker_status)
1529
 
    
 
2056
 
1530
2057
    # Expires - property
1531
2058
    @dbus_service_property(_interface, signature="s", access="read")
1532
2059
    def Expires_dbus_property(self):
1533
2060
        return datetime_to_dbus(self.expires)
1534
 
    
 
2061
 
1535
2062
    # LastApprovalRequest - property
1536
2063
    @dbus_service_property(_interface, signature="s", access="read")
1537
2064
    def LastApprovalRequest_dbus_property(self):
1538
2065
        return datetime_to_dbus(self.last_approval_request)
1539
 
    
 
2066
 
1540
2067
    # Timeout - property
1541
 
    @dbus_service_property(_interface, signature="t",
 
2068
    @dbus_service_property(_interface,
 
2069
                           signature="t",
1542
2070
                           access="readwrite")
1543
2071
    def Timeout_dbus_property(self, value=None):
1544
2072
        if value is None:       # get
1556
2084
                if (getattr(self, "disable_initiator_tag", None)
1557
2085
                    is None):
1558
2086
                    return
1559
 
                gobject.source_remove(self.disable_initiator_tag)
1560
 
                self.disable_initiator_tag = (
1561
 
                    gobject.timeout_add(
1562
 
                        int((self.expires - now).total_seconds()
1563
 
                            * 1000), self.disable))
1564
 
    
 
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
 
1565
2092
    # ExtendedTimeout - property
1566
 
    @dbus_service_property(_interface, signature="t",
 
2093
    @dbus_service_property(_interface,
 
2094
                           signature="t",
1567
2095
                           access="readwrite")
1568
2096
    def ExtendedTimeout_dbus_property(self, value=None):
1569
2097
        if value is None:       # get
1570
2098
            return dbus.UInt64(self.extended_timeout.total_seconds()
1571
2099
                               * 1000)
1572
2100
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1573
 
    
 
2101
 
1574
2102
    # Interval - property
1575
 
    @dbus_service_property(_interface, signature="t",
 
2103
    @dbus_service_property(_interface,
 
2104
                           signature="t",
1576
2105
                           access="readwrite")
1577
2106
    def Interval_dbus_property(self, value=None):
1578
2107
        if value is None:       # get
1582
2111
            return
1583
2112
        if self.enabled:
1584
2113
            # Reschedule checker run
1585
 
            gobject.source_remove(self.checker_initiator_tag)
1586
 
            self.checker_initiator_tag = (gobject.timeout_add
1587
 
                                          (value, self.start_checker))
1588
 
            self.start_checker()    # Start one now, too
1589
 
    
 
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
 
1590
2119
    # Checker - property
1591
 
    @dbus_service_property(_interface, signature="s",
 
2120
    @dbus_service_property(_interface,
 
2121
                           signature="s",
1592
2122
                           access="readwrite")
1593
2123
    def Checker_dbus_property(self, value=None):
1594
2124
        if value is None:       # get
1595
2125
            return dbus.String(self.checker_command)
1596
 
        self.checker_command = unicode(value)
1597
 
    
 
2126
        self.checker_command = str(value)
 
2127
 
1598
2128
    # CheckerRunning - property
1599
 
    @dbus_service_property(_interface, signature="b",
 
2129
    @dbus_service_property(_interface,
 
2130
                           signature="b",
1600
2131
                           access="readwrite")
1601
2132
    def CheckerRunning_dbus_property(self, value=None):
1602
2133
        if value is None:       # get
1605
2136
            self.start_checker()
1606
2137
        else:
1607
2138
            self.stop_checker()
1608
 
    
 
2139
 
1609
2140
    # ObjectPath - property
 
2141
    @dbus_annotations(
 
2142
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2143
         "org.freedesktop.DBus.Deprecated": "true"})
1610
2144
    @dbus_service_property(_interface, signature="o", access="read")
1611
2145
    def ObjectPath_dbus_property(self):
1612
 
        return self.dbus_object_path # is already a dbus.ObjectPath
1613
 
    
 
2146
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
2147
 
1614
2148
    # Secret = property
1615
 
    @dbus_service_property(_interface, signature="ay",
1616
 
                           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)
1617
2156
    def Secret_dbus_property(self, value):
1618
 
        self.secret = str(value)
1619
 
    
 
2157
        self.secret = bytes(value)
 
2158
 
1620
2159
    del _interface
1621
2160
 
1622
2161
 
1625
2164
        self._pipe = child_pipe
1626
2165
        self._pipe.send(('init', fpr, address))
1627
2166
        if not self._pipe.recv():
1628
 
            raise KeyError()
1629
 
    
 
2167
            raise KeyError(fpr)
 
2168
 
1630
2169
    def __getattribute__(self, name):
1631
2170
        if name == '_pipe':
1632
2171
            return super(ProxyClient, self).__getattribute__(name)
1635
2174
        if data[0] == 'data':
1636
2175
            return data[1]
1637
2176
        if data[0] == 'function':
 
2177
 
1638
2178
            def func(*args, **kwargs):
1639
2179
                self._pipe.send(('funcall', name, args, kwargs))
1640
2180
                return self._pipe.recv()[1]
 
2181
 
1641
2182
            return func
1642
 
    
 
2183
 
1643
2184
    def __setattr__(self, name, value):
1644
2185
        if name == '_pipe':
1645
2186
            return super(ProxyClient, self).__setattr__(name, value)
1648
2189
 
1649
2190
class ClientHandler(socketserver.BaseRequestHandler, object):
1650
2191
    """A class to handle client connections.
1651
 
    
 
2192
 
1652
2193
    Instantiated once for each connection to handle it.
1653
2194
    Note: This will run in its own forked process."""
1654
 
    
 
2195
 
1655
2196
    def handle(self):
1656
2197
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1657
2198
            logger.info("TCP connection from: %s",
1658
 
                        unicode(self.client_address))
 
2199
                        str(self.client_address))
1659
2200
            logger.debug("Pipe FD: %d",
1660
2201
                         self.server.child_pipe.fileno())
1661
 
            
1662
 
            session = (gnutls.connection
1663
 
                       .ClientSession(self.request,
1664
 
                                      gnutls.connection
1665
 
                                      .X509Credentials()))
1666
 
            
1667
 
            # Note: gnutls.connection.X509Credentials is really a
1668
 
            # generic GnuTLS certificate credentials object so long as
1669
 
            # no X.509 keys are added to it.  Therefore, we can use it
1670
 
            # here despite using OpenPGP certificates.
1671
 
            
1672
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1673
 
            #                      "+AES-256-CBC", "+SHA1",
1674
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1675
 
            #                      "+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"))
1676
2209
            # Use a fallback default, since this MUST be set.
1677
2210
            priority = self.server.gnutls_priority
1678
2211
            if priority is None:
1679
2212
                priority = "NORMAL"
1680
 
            (gnutls.library.functions
1681
 
             .gnutls_priority_set_direct(session._c_object,
1682
 
                                         priority, None))
1683
 
            
 
2213
            gnutls.priority_set_direct(session._c_object,
 
2214
                                       priority.encode("utf-8"),
 
2215
                                       None)
 
2216
 
1684
2217
            # Start communication using the Mandos protocol
1685
2218
            # Get protocol number
1686
2219
            line = self.request.makefile().readline()
1691
2224
            except (ValueError, IndexError, RuntimeError) as error:
1692
2225
                logger.error("Unknown protocol version: %s", error)
1693
2226
                return
1694
 
            
 
2227
 
1695
2228
            # Start GnuTLS connection
1696
2229
            try:
1697
2230
                session.handshake()
1698
 
            except gnutls.errors.GNUTLSError as error:
 
2231
            except gnutls.Error as error:
1699
2232
                logger.warning("Handshake failed: %s", error)
1700
2233
                # Do not run session.bye() here: the session is not
1701
2234
                # established.  Just abandon the request.
1702
2235
                return
1703
2236
            logger.debug("Handshake succeeded")
1704
 
            
 
2237
 
1705
2238
            approval_required = False
1706
2239
            try:
1707
2240
                try:
1708
 
                    fpr = self.fingerprint(self.peer_certificate
1709
 
                                           (session))
1710
 
                except (TypeError,
1711
 
                        gnutls.errors.GNUTLSError) as error:
 
2241
                    fpr = self.fingerprint(
 
2242
                        self.peer_certificate(session))
 
2243
                except (TypeError, gnutls.Error) as error:
1712
2244
                    logger.warning("Bad certificate: %s", error)
1713
2245
                    return
1714
2246
                logger.debug("Fingerprint: %s", fpr)
1715
 
                
 
2247
 
1716
2248
                try:
1717
2249
                    client = ProxyClient(child_pipe, fpr,
1718
2250
                                         self.client_address)
1719
2251
                except KeyError:
1720
2252
                    return
1721
 
                
 
2253
 
1722
2254
                if client.approval_delay:
1723
2255
                    delay = client.approval_delay
1724
2256
                    client.approvals_pending += 1
1725
2257
                    approval_required = True
1726
 
                
 
2258
 
1727
2259
                while True:
1728
2260
                    if not client.enabled:
1729
2261
                        logger.info("Client %s is disabled",
1730
 
                                       client.name)
 
2262
                                    client.name)
1731
2263
                        if self.server.use_dbus:
1732
2264
                            # Emit D-Bus signal
1733
2265
                            client.Rejected("Disabled")
1734
2266
                        return
1735
 
                    
 
2267
 
1736
2268
                    if client.approved or not client.approval_delay:
1737
 
                        #We are approved or approval is disabled
 
2269
                        # We are approved or approval is disabled
1738
2270
                        break
1739
2271
                    elif client.approved is None:
1740
2272
                        logger.info("Client %s needs approval",
1751
2283
                            # Emit D-Bus signal
1752
2284
                            client.Rejected("Denied")
1753
2285
                        return
1754
 
                    
1755
 
                    #wait until timeout or approved
 
2286
 
 
2287
                    # wait until timeout or approved
1756
2288
                    time = datetime.datetime.now()
1757
2289
                    client.changedstate.acquire()
1758
2290
                    client.changedstate.wait(delay.total_seconds())
1771
2303
                            break
1772
2304
                    else:
1773
2305
                        delay -= time2 - time
1774
 
                
1775
 
                sent_size = 0
1776
 
                while sent_size < len(client.secret):
1777
 
                    try:
1778
 
                        sent = session.send(client.secret[sent_size:])
1779
 
                    except gnutls.errors.GNUTLSError as error:
1780
 
                        logger.warning("gnutls send failed",
1781
 
                                       exc_info=error)
1782
 
                        return
1783
 
                    logger.debug("Sent: %d, remaining: %d",
1784
 
                                 sent, len(client.secret)
1785
 
                                 - (sent_size + sent))
1786
 
                    sent_size += sent
1787
 
                
 
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
 
1788
2314
                logger.info("Sending secret to %s", client.name)
1789
2315
                # bump the timeout using extended_timeout
1790
2316
                client.bump_timeout(client.extended_timeout)
1791
2317
                if self.server.use_dbus:
1792
2318
                    # Emit D-Bus signal
1793
2319
                    client.GotSecret()
1794
 
            
 
2320
 
1795
2321
            finally:
1796
2322
                if approval_required:
1797
2323
                    client.approvals_pending -= 1
1798
2324
                try:
1799
2325
                    session.bye()
1800
 
                except gnutls.errors.GNUTLSError as error:
 
2326
                except gnutls.Error as error:
1801
2327
                    logger.warning("GnuTLS bye failed",
1802
2328
                                   exc_info=error)
1803
 
    
 
2329
 
1804
2330
    @staticmethod
1805
2331
    def peer_certificate(session):
1806
2332
        "Return the peer's OpenPGP certificate as a bytestring"
1807
2333
        # If not an OpenPGP certificate...
1808
 
        if (gnutls.library.functions
1809
 
            .gnutls_certificate_type_get(session._c_object)
1810
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1811
 
            # ...do the normal thing
1812
 
            return session.peer_certificate
 
2334
        if (gnutls.certificate_type_get(session._c_object)
 
2335
            != gnutls.CRT_OPENPGP):
 
2336
            # ...return invalid data
 
2337
            return b""
1813
2338
        list_size = ctypes.c_uint(1)
1814
 
        cert_list = (gnutls.library.functions
1815
 
                     .gnutls_certificate_get_peers
 
2339
        cert_list = (gnutls.certificate_get_peers
1816
2340
                     (session._c_object, ctypes.byref(list_size)))
1817
2341
        if not bool(cert_list) and list_size.value != 0:
1818
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1819
 
                                            " certificate")
 
2342
            raise gnutls.Error("error getting peer certificate")
1820
2343
        if list_size.value == 0:
1821
2344
            return None
1822
2345
        cert = cert_list[0]
1823
2346
        return ctypes.string_at(cert.data, cert.size)
1824
 
    
 
2347
 
1825
2348
    @staticmethod
1826
2349
    def fingerprint(openpgp):
1827
2350
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1828
2351
        # New GnuTLS "datum" with the OpenPGP public key
1829
 
        datum = (gnutls.library.types
1830
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1831
 
                                             ctypes.POINTER
1832
 
                                             (ctypes.c_ubyte)),
1833
 
                                 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)))
1834
2356
        # New empty GnuTLS certificate
1835
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1836
 
        (gnutls.library.functions
1837
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2357
        crt = gnutls.openpgp_crt_t()
 
2358
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1838
2359
        # Import the OpenPGP public key into the certificate
1839
 
        (gnutls.library.functions
1840
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1841
 
                                    gnutls.library.constants
1842
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2360
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2361
                                  gnutls.OPENPGP_FMT_RAW)
1843
2362
        # Verify the self signature in the key
1844
2363
        crtverify = ctypes.c_uint()
1845
 
        (gnutls.library.functions
1846
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1847
 
                                         ctypes.byref(crtverify)))
 
2364
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2365
                                       ctypes.byref(crtverify))
1848
2366
        if crtverify.value != 0:
1849
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1850
 
            raise (gnutls.errors.CertificateSecurityError
1851
 
                   ("Verify failed"))
 
2367
            gnutls.openpgp_crt_deinit(crt)
 
2368
            raise gnutls.CertificateSecurityError("Verify failed")
1852
2369
        # New buffer for the fingerprint
1853
2370
        buf = ctypes.create_string_buffer(20)
1854
2371
        buf_len = ctypes.c_size_t()
1855
2372
        # Get the fingerprint from the certificate into the buffer
1856
 
        (gnutls.library.functions
1857
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1858
 
                                             ctypes.byref(buf_len)))
 
2373
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2374
                                           ctypes.byref(buf_len))
1859
2375
        # Deinit the certificate
1860
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2376
        gnutls.openpgp_crt_deinit(crt)
1861
2377
        # Convert the buffer to a Python bytestring
1862
2378
        fpr = ctypes.string_at(buf, buf_len.value)
1863
2379
        # Convert the bytestring to hexadecimal notation
1867
2383
 
1868
2384
class MultiprocessingMixIn(object):
1869
2385
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2386
 
1870
2387
    def sub_process_main(self, request, address):
1871
2388
        try:
1872
2389
            self.finish_request(request, address)
1873
2390
        except Exception:
1874
2391
            self.handle_error(request, address)
1875
2392
        self.close_request(request)
1876
 
    
 
2393
 
1877
2394
    def process_request(self, request, address):
1878
2395
        """Start a new process to process the request."""
1879
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1880
 
                                       args = (request, address))
 
2396
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2397
                                       args=(request, address))
1881
2398
        proc.start()
1882
2399
        return proc
1883
2400
 
1884
2401
 
1885
2402
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1886
2403
    """ adds a pipe to the MixIn """
 
2404
 
1887
2405
    def process_request(self, request, client_address):
1888
2406
        """Overrides and wraps the original process_request().
1889
 
        
 
2407
 
1890
2408
        This function creates a new pipe in self.pipe
1891
2409
        """
1892
2410
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1893
 
        
 
2411
 
1894
2412
        proc = MultiprocessingMixIn.process_request(self, request,
1895
2413
                                                    client_address)
1896
2414
        self.child_pipe.close()
1897
2415
        self.add_pipe(parent_pipe, proc)
1898
 
    
 
2416
 
1899
2417
    def add_pipe(self, parent_pipe, proc):
1900
2418
        """Dummy function; override as necessary"""
1901
2419
        raise NotImplementedError()
1904
2422
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1905
2423
                     socketserver.TCPServer, object):
1906
2424
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1907
 
    
 
2425
 
1908
2426
    Attributes:
1909
2427
        enabled:        Boolean; whether this server is activated yet
1910
2428
        interface:      None or a network interface name (string)
1911
2429
        use_ipv6:       Boolean; to use IPv6 or not
1912
2430
    """
 
2431
 
1913
2432
    def __init__(self, server_address, RequestHandlerClass,
1914
 
                 interface=None, use_ipv6=True, socketfd=None):
 
2433
                 interface=None,
 
2434
                 use_ipv6=True,
 
2435
                 socketfd=None):
1915
2436
        """If socketfd is set, use that file descriptor instead of
1916
2437
        creating a new one with socket.socket().
1917
2438
        """
1923
2444
            self.socketfd = socketfd
1924
2445
            # Save the original socket.socket() function
1925
2446
            self.socket_socket = socket.socket
 
2447
 
1926
2448
            # To implement --socket, we monkey patch socket.socket.
1927
 
            # 
 
2449
            #
1928
2450
            # (When socketserver.TCPServer is a new-style class, we
1929
2451
            # could make self.socket into a property instead of monkey
1930
2452
            # patching socket.socket.)
1931
 
            # 
 
2453
            #
1932
2454
            # Create a one-time-only replacement for socket.socket()
1933
2455
            @functools.wraps(socket.socket)
1934
2456
            def socket_wrapper(*args, **kwargs):
1946
2468
        # socket_wrapper(), if socketfd was set.
1947
2469
        socketserver.TCPServer.__init__(self, server_address,
1948
2470
                                        RequestHandlerClass)
1949
 
    
 
2471
 
1950
2472
    def server_bind(self):
1951
2473
        """This overrides the normal server_bind() function
1952
2474
        to bind to an interface if one was specified, and also NOT to
1953
2475
        bind to an address or port if they were not specified."""
 
2476
        global SO_BINDTODEVICE
1954
2477
        if self.interface is not None:
1955
2478
            if SO_BINDTODEVICE is None:
1956
 
                logger.error("SO_BINDTODEVICE does not exist;"
1957
 
                             " cannot bind to interface %s",
1958
 
                             self.interface)
1959
 
            else:
1960
 
                try:
1961
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1962
 
                                           SO_BINDTODEVICE,
1963
 
                                           str(self.interface + '\0'))
1964
 
                except socket.error as error:
1965
 
                    if error.errno == errno.EPERM:
1966
 
                        logger.error("No permission to bind to"
1967
 
                                     " interface %s", self.interface)
1968
 
                    elif error.errno == errno.ENOPROTOOPT:
1969
 
                        logger.error("SO_BINDTODEVICE not available;"
1970
 
                                     " cannot bind to interface %s",
1971
 
                                     self.interface)
1972
 
                    elif error.errno == errno.ENODEV:
1973
 
                        logger.error("Interface %s does not exist,"
1974
 
                                     " cannot bind", self.interface)
1975
 
                    else:
1976
 
                        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
1977
2500
        # Only bind(2) the socket if we really need to.
1978
2501
        if self.server_address[0] or self.server_address[1]:
1979
2502
            if not self.server_address[0]:
1980
2503
                if self.address_family == socket.AF_INET6:
1981
 
                    any_address = "::" # in6addr_any
 
2504
                    any_address = "::"  # in6addr_any
1982
2505
                else:
1983
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
2506
                    any_address = "0.0.0.0"  # INADDR_ANY
1984
2507
                self.server_address = (any_address,
1985
2508
                                       self.server_address[1])
1986
2509
            elif not self.server_address[1]:
1987
 
                self.server_address = (self.server_address[0],
1988
 
                                       0)
 
2510
                self.server_address = (self.server_address[0], 0)
1989
2511
#                 if self.interface:
1990
2512
#                     self.server_address = (self.server_address[0],
1991
2513
#                                            0, # port
1997
2519
 
1998
2520
class MandosServer(IPv6_TCPServer):
1999
2521
    """Mandos server.
2000
 
    
 
2522
 
2001
2523
    Attributes:
2002
2524
        clients:        set of Client objects
2003
2525
        gnutls_priority GnuTLS priority string
2004
2526
        use_dbus:       Boolean; to emit D-Bus signals or not
2005
 
    
2006
 
    Assumes a gobject.MainLoop event loop.
 
2527
 
 
2528
    Assumes a GLib.MainLoop event loop.
2007
2529
    """
 
2530
 
2008
2531
    def __init__(self, server_address, RequestHandlerClass,
2009
 
                 interface=None, use_ipv6=True, clients=None,
2010
 
                 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):
2011
2538
        self.enabled = False
2012
2539
        self.clients = clients
2013
2540
        if self.clients is None:
2016
2543
        self.gnutls_priority = gnutls_priority
2017
2544
        IPv6_TCPServer.__init__(self, server_address,
2018
2545
                                RequestHandlerClass,
2019
 
                                interface = interface,
2020
 
                                use_ipv6 = use_ipv6,
2021
 
                                socketfd = socketfd)
 
2546
                                interface=interface,
 
2547
                                use_ipv6=use_ipv6,
 
2548
                                socketfd=socketfd)
 
2549
 
2022
2550
    def server_activate(self):
2023
2551
        if self.enabled:
2024
2552
            return socketserver.TCPServer.server_activate(self)
2025
 
    
 
2553
 
2026
2554
    def enable(self):
2027
2555
        self.enabled = True
2028
 
    
 
2556
 
2029
2557
    def add_pipe(self, parent_pipe, proc):
2030
2558
        # Call "handle_ipc" for both data and EOF events
2031
 
        gobject.io_add_watch(parent_pipe.fileno(),
2032
 
                             gobject.IO_IN | gobject.IO_HUP,
2033
 
                             functools.partial(self.handle_ipc,
2034
 
                                               parent_pipe =
2035
 
                                               parent_pipe,
2036
 
                                               proc = proc))
2037
 
    
2038
 
    def handle_ipc(self, source, condition, parent_pipe=None,
2039
 
                   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):
2040
2570
        # error, or the other end of multiprocessing.Pipe has closed
2041
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2571
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
2042
2572
            # Wait for other process to exit
2043
2573
            proc.join()
2044
2574
            return False
2045
 
        
 
2575
 
2046
2576
        # Read a request from the child
2047
2577
        request = parent_pipe.recv()
2048
2578
        command = request[0]
2049
 
        
 
2579
 
2050
2580
        if command == 'init':
2051
 
            fpr = request[1]
 
2581
            fpr = request[1].decode("ascii")
2052
2582
            address = request[2]
2053
 
            
2054
 
            for c in self.clients.itervalues():
 
2583
 
 
2584
            for c in self.clients.values():
2055
2585
                if c.fingerprint == fpr:
2056
2586
                    client = c
2057
2587
                    break
2064
2594
                                                       address[0])
2065
2595
                parent_pipe.send(False)
2066
2596
                return False
2067
 
            
2068
 
            gobject.io_add_watch(parent_pipe.fileno(),
2069
 
                                 gobject.IO_IN | gobject.IO_HUP,
2070
 
                                 functools.partial(self.handle_ipc,
2071
 
                                                   parent_pipe =
2072
 
                                                   parent_pipe,
2073
 
                                                   proc = proc,
2074
 
                                                   client_object =
2075
 
                                                   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))
2076
2605
            parent_pipe.send(True)
2077
2606
            # remove the old hook in favor of the new above hook on
2078
2607
            # same fileno
2081
2610
            funcname = request[1]
2082
2611
            args = request[2]
2083
2612
            kwargs = request[3]
2084
 
            
 
2613
 
2085
2614
            parent_pipe.send(('data', getattr(client_object,
2086
2615
                                              funcname)(*args,
2087
 
                                                         **kwargs)))
2088
 
        
 
2616
                                                        **kwargs)))
 
2617
 
2089
2618
        if command == 'getattr':
2090
2619
            attrname = request[1]
2091
 
            if callable(client_object.__getattribute__(attrname)):
2092
 
                parent_pipe.send(('function',))
 
2620
            if isinstance(client_object.__getattribute__(attrname),
 
2621
                          collections.Callable):
 
2622
                parent_pipe.send(('function', ))
2093
2623
            else:
2094
 
                parent_pipe.send(('data', client_object
2095
 
                                  .__getattribute__(attrname)))
2096
 
        
 
2624
                parent_pipe.send((
 
2625
                    'data', client_object.__getattribute__(attrname)))
 
2626
 
2097
2627
        if command == 'setattr':
2098
2628
            attrname = request[1]
2099
2629
            value = request[2]
2100
2630
            setattr(client_object, attrname, value)
2101
 
        
 
2631
 
2102
2632
        return True
2103
2633
 
2104
2634
 
2105
2635
def rfc3339_duration_to_delta(duration):
2106
2636
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2107
 
    
 
2637
 
2108
2638
    >>> rfc3339_duration_to_delta("P7D")
2109
2639
    datetime.timedelta(7)
2110
2640
    >>> rfc3339_duration_to_delta("PT60S")
2120
2650
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2121
2651
    datetime.timedelta(1, 200)
2122
2652
    """
2123
 
    
 
2653
 
2124
2654
    # Parsing an RFC 3339 duration with regular expressions is not
2125
2655
    # possible - there would have to be multiple places for the same
2126
2656
    # values, like seconds.  The current code, while more esoteric, is
2127
2657
    # cleaner without depending on a parsing library.  If Python had a
2128
2658
    # built-in library for parsing we would use it, but we'd like to
2129
2659
    # avoid excessive use of external libraries.
2130
 
    
 
2660
 
2131
2661
    # New type for defining tokens, syntax, and semantics all-in-one
2132
 
    Token = collections.namedtuple("Token",
2133
 
                                   ("regexp", # To match token; if
2134
 
                                              # "value" is not None,
2135
 
                                              # must have a "group"
2136
 
                                              # containing digits
2137
 
                                    "value",  # datetime.timedelta or
2138
 
                                              # None
2139
 
                                    "followers")) # Tokens valid after
2140
 
                                                  # 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
2141
2667
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2142
2668
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2143
2669
    token_end = Token(re.compile(r"$"), None, frozenset())
2144
2670
    token_second = Token(re.compile(r"(\d+)S"),
2145
2671
                         datetime.timedelta(seconds=1),
2146
 
                         frozenset((token_end,)))
 
2672
                         frozenset((token_end, )))
2147
2673
    token_minute = Token(re.compile(r"(\d+)M"),
2148
2674
                         datetime.timedelta(minutes=1),
2149
2675
                         frozenset((token_second, token_end)))
2165
2691
                       frozenset((token_month, token_end)))
2166
2692
    token_week = Token(re.compile(r"(\d+)W"),
2167
2693
                       datetime.timedelta(weeks=1),
2168
 
                       frozenset((token_end,)))
 
2694
                       frozenset((token_end, )))
2169
2695
    token_duration = Token(re.compile(r"P"), None,
2170
2696
                           frozenset((token_year, token_month,
2171
2697
                                      token_day, token_time,
2172
2698
                                      token_week)))
2173
 
    # Define starting values
2174
 
    value = datetime.timedelta() # Value so far
 
2699
    # Define starting values:
 
2700
    # Value so far
 
2701
    value = datetime.timedelta()
2175
2702
    found_token = None
2176
 
    followers = frozenset((token_duration,)) # Following valid tokens
2177
 
    s = duration                # String left to parse
 
2703
    # Following valid tokens
 
2704
    followers = frozenset((token_duration, ))
 
2705
    # String left to parse
 
2706
    s = duration
2178
2707
    # Loop until end token is found
2179
2708
    while found_token is not token_end:
2180
2709
        # Search for any currently valid tokens
2196
2725
                break
2197
2726
        else:
2198
2727
            # No currently valid tokens were found
2199
 
            raise ValueError("Invalid RFC 3339 duration")
 
2728
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2729
                             .format(duration))
2200
2730
    # End token found
2201
2731
    return value
2202
2732
 
2203
2733
 
2204
2734
def string_to_delta(interval):
2205
2735
    """Parse a string and return a datetime.timedelta
2206
 
    
 
2736
 
2207
2737
    >>> string_to_delta('7d')
2208
2738
    datetime.timedelta(7)
2209
2739
    >>> string_to_delta('60s')
2217
2747
    >>> string_to_delta('5m 30s')
2218
2748
    datetime.timedelta(0, 330)
2219
2749
    """
2220
 
    
 
2750
 
2221
2751
    try:
2222
2752
        return rfc3339_duration_to_delta(interval)
2223
2753
    except ValueError:
2224
2754
        pass
2225
 
    
 
2755
 
2226
2756
    timevalue = datetime.timedelta(0)
2227
2757
    for s in interval.split():
2228
2758
        try:
2229
 
            suffix = unicode(s[-1])
 
2759
            suffix = s[-1]
2230
2760
            value = int(s[:-1])
2231
2761
            if suffix == "d":
2232
2762
                delta = datetime.timedelta(value)
2239
2769
            elif suffix == "w":
2240
2770
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2241
2771
            else:
2242
 
                raise ValueError("Unknown suffix {!r}"
2243
 
                                 .format(suffix))
 
2772
                raise ValueError("Unknown suffix {!r}".format(suffix))
2244
2773
        except IndexError as e:
2245
2774
            raise ValueError(*(e.args))
2246
2775
        timevalue += delta
2247
2776
    return timevalue
2248
2777
 
2249
2778
 
2250
 
def daemon(nochdir = False, noclose = False):
 
2779
def daemon(nochdir=False, noclose=False):
2251
2780
    """See daemon(3).  Standard BSD Unix function.
2252
 
    
 
2781
 
2253
2782
    This should really exist as os.daemon, but it doesn't (yet)."""
2254
2783
    if os.fork():
2255
2784
        sys.exit()
2262
2791
        # Close all standard open file descriptors
2263
2792
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2264
2793
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2265
 
            raise OSError(errno.ENODEV, "{} not a character device"
 
2794
            raise OSError(errno.ENODEV,
 
2795
                          "{} not a character device"
2266
2796
                          .format(os.devnull))
2267
2797
        os.dup2(null, sys.stdin.fileno())
2268
2798
        os.dup2(null, sys.stdout.fileno())
2272
2802
 
2273
2803
 
2274
2804
def main():
2275
 
    
 
2805
 
2276
2806
    ##################################################################
2277
2807
    # Parsing of options, both command line and config file
2278
 
    
 
2808
 
2279
2809
    parser = argparse.ArgumentParser()
2280
2810
    parser.add_argument("-v", "--version", action="version",
2281
 
                        version = "%(prog)s {}".format(version),
 
2811
                        version="%(prog)s {}".format(version),
2282
2812
                        help="show version number and exit")
2283
2813
    parser.add_argument("-i", "--interface", metavar="IF",
2284
2814
                        help="Bind to interface IF")
2320
2850
    parser.add_argument("--no-zeroconf", action="store_false",
2321
2851
                        dest="zeroconf", help="Do not use Zeroconf",
2322
2852
                        default=None)
2323
 
    
 
2853
 
2324
2854
    options = parser.parse_args()
2325
 
    
 
2855
 
2326
2856
    if options.check:
2327
2857
        import doctest
2328
2858
        fail_count, test_count = doctest.testmod()
2329
2859
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2330
 
    
 
2860
 
2331
2861
    # Default values for config file for server-global settings
2332
 
    server_defaults = { "interface": "",
2333
 
                        "address": "",
2334
 
                        "port": "",
2335
 
                        "debug": "False",
2336
 
                        "priority":
2337
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2338
 
                        "servicename": "Mandos",
2339
 
                        "use_dbus": "True",
2340
 
                        "use_ipv6": "True",
2341
 
                        "debuglevel": "",
2342
 
                        "restore": "True",
2343
 
                        "socket": "",
2344
 
                        "statedir": "/var/lib/mandos",
2345
 
                        "foreground": "False",
2346
 
                        "zeroconf": "True",
2347
 
                        }
2348
 
    
 
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
 
2349
2880
    # Parse config file for server-global settings
2350
2881
    server_config = configparser.SafeConfigParser(server_defaults)
2351
2882
    del server_defaults
2352
 
    server_config.read(os.path.join(options.configdir,
2353
 
                                    "mandos.conf"))
 
2883
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2354
2884
    # Convert the SafeConfigParser object to a dict
2355
2885
    server_settings = server_config.defaults()
2356
2886
    # Use the appropriate methods on the non-string config options
2357
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
2887
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2888
                   "foreground", "zeroconf"):
2358
2889
        server_settings[option] = server_config.getboolean("DEFAULT",
2359
2890
                                                           option)
2360
2891
    if server_settings["port"]:
2370
2901
            server_settings["socket"] = os.dup(server_settings
2371
2902
                                               ["socket"])
2372
2903
    del server_config
2373
 
    
 
2904
 
2374
2905
    # Override the settings from the config file with command line
2375
2906
    # options, if set.
2376
2907
    for option in ("interface", "address", "port", "debug",
2377
 
                   "priority", "servicename", "configdir",
2378
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2379
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
2908
                   "priority", "servicename", "configdir", "use_dbus",
 
2909
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2910
                   "socket", "foreground", "zeroconf"):
2380
2911
        value = getattr(options, option)
2381
2912
        if value is not None:
2382
2913
            server_settings[option] = value
2383
2914
    del options
2384
2915
    # Force all strings to be unicode
2385
2916
    for option in server_settings.keys():
2386
 
        if type(server_settings[option]) is str:
2387
 
            server_settings[option] = unicode(server_settings[option])
 
2917
        if isinstance(server_settings[option], bytes):
 
2918
            server_settings[option] = (server_settings[option]
 
2919
                                       .decode("utf-8"))
2388
2920
    # Force all boolean options to be boolean
2389
2921
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2390
2922
                   "foreground", "zeroconf"):
2393
2925
    if server_settings["debug"]:
2394
2926
        server_settings["foreground"] = True
2395
2927
    # Now we have our good server settings in "server_settings"
2396
 
    
 
2928
 
2397
2929
    ##################################################################
2398
 
    
2399
 
    if (not server_settings["zeroconf"] and
2400
 
        not (server_settings["port"]
2401
 
             or server_settings["socket"] != "")):
2402
 
            parser.error("Needs port or socket to work without"
2403
 
                         " Zeroconf")
2404
 
    
 
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
 
2405
2936
    # For convenience
2406
2937
    debug = server_settings["debug"]
2407
2938
    debuglevel = server_settings["debuglevel"]
2411
2942
                                     stored_state_file)
2412
2943
    foreground = server_settings["foreground"]
2413
2944
    zeroconf = server_settings["zeroconf"]
2414
 
    
 
2945
 
2415
2946
    if debug:
2416
2947
        initlogger(debug, logging.DEBUG)
2417
2948
    else:
2420
2951
        else:
2421
2952
            level = getattr(logging, debuglevel.upper())
2422
2953
            initlogger(debug, level)
2423
 
    
 
2954
 
2424
2955
    if server_settings["servicename"] != "Mandos":
2425
 
        syslogger.setFormatter(logging.Formatter
2426
 
                               ('Mandos ({}) [%(process)d]:'
2427
 
                                ' %(levelname)s: %(message)s'
2428
 
                                .format(server_settings
2429
 
                                        ["servicename"])))
2430
 
    
 
2956
        syslogger.setFormatter(
 
2957
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2958
                              ' %(levelname)s: %(message)s'.format(
 
2959
                                  server_settings["servicename"])))
 
2960
 
2431
2961
    # Parse config file with clients
2432
2962
    client_config = configparser.SafeConfigParser(Client
2433
2963
                                                  .client_defaults)
2434
2964
    client_config.read(os.path.join(server_settings["configdir"],
2435
2965
                                    "clients.conf"))
2436
 
    
 
2966
 
2437
2967
    global mandos_dbus_service
2438
2968
    mandos_dbus_service = None
2439
 
    
 
2969
 
2440
2970
    socketfd = None
2441
2971
    if server_settings["socket"] != "":
2442
2972
        socketfd = server_settings["socket"]
2443
 
    tcp_server = MandosServer((server_settings["address"],
2444
 
                               server_settings["port"]),
2445
 
                              ClientHandler,
2446
 
                              interface=(server_settings["interface"]
2447
 
                                         or None),
2448
 
                              use_ipv6=use_ipv6,
2449
 
                              gnutls_priority=
2450
 
                              server_settings["priority"],
2451
 
                              use_dbus=use_dbus,
2452
 
                              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)
2453
2981
    if not foreground:
2454
2982
        pidfilename = "/run/mandos.pid"
2455
2983
        if not os.path.isdir("/run/."):
2456
2984
            pidfilename = "/var/run/mandos.pid"
2457
2985
        pidfile = None
2458
2986
        try:
2459
 
            pidfile = open(pidfilename, "w")
 
2987
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2460
2988
        except IOError as e:
2461
2989
            logger.error("Could not open file %r", pidfilename,
2462
2990
                         exc_info=e)
2463
 
    
2464
 
    for name in ("_mandos", "mandos", "nobody"):
 
2991
 
 
2992
    for name, group in (("_mandos", "_mandos"),
 
2993
                        ("mandos", "mandos"),
 
2994
                        ("nobody", "nogroup")):
2465
2995
        try:
2466
2996
            uid = pwd.getpwnam(name).pw_uid
2467
 
            gid = pwd.getpwnam(name).pw_gid
 
2997
            gid = pwd.getpwnam(group).pw_gid
2468
2998
            break
2469
2999
        except KeyError:
2470
3000
            continue
2474
3004
    try:
2475
3005
        os.setgid(gid)
2476
3006
        os.setuid(uid)
 
3007
        if debug:
 
3008
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3009
                                                             gid))
2477
3010
    except OSError as error:
 
3011
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3012
                       .format(uid, gid, os.strerror(error.errno)))
2478
3013
        if error.errno != errno.EPERM:
2479
3014
            raise
2480
 
    
 
3015
 
2481
3016
    if debug:
2482
3017
        # Enable all possible GnuTLS debugging
2483
 
        
 
3018
 
2484
3019
        # "Use a log level over 10 to enable all debugging options."
2485
3020
        # - GnuTLS manual
2486
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
2487
 
        
2488
 
        @gnutls.library.types.gnutls_log_func
 
3021
        gnutls.global_set_log_level(11)
 
3022
 
 
3023
        @gnutls.log_func
2489
3024
        def debug_gnutls(level, string):
2490
3025
            logger.debug("GnuTLS: %s", string[:-1])
2491
 
        
2492
 
        (gnutls.library.functions
2493
 
         .gnutls_global_set_log_function(debug_gnutls))
2494
 
        
 
3026
 
 
3027
        gnutls.global_set_log_function(debug_gnutls)
 
3028
 
2495
3029
        # Redirect stdin so all checkers get /dev/null
2496
3030
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2497
3031
        os.dup2(null, sys.stdin.fileno())
2498
3032
        if null > 2:
2499
3033
            os.close(null)
2500
 
    
 
3034
 
2501
3035
    # Need to fork before connecting to D-Bus
2502
3036
    if not foreground:
2503
3037
        # Close all input and output, do double fork, etc.
2504
3038
        daemon()
2505
 
    
2506
 
    # multiprocessing will use threads, so before we use gobject we
2507
 
    # need to inform gobject that threads will be used.
2508
 
    gobject.threads_init()
2509
 
    
 
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
 
2510
3044
    global main_loop
2511
3045
    # From the Avahi example code
2512
3046
    DBusGMainLoop(set_as_default=True)
2513
 
    main_loop = gobject.MainLoop()
 
3047
    main_loop = GLib.MainLoop()
2514
3048
    bus = dbus.SystemBus()
2515
3049
    # End of Avahi example code
2516
3050
    if use_dbus:
2517
3051
        try:
2518
3052
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2519
 
                                            bus, do_not_queue=True)
2520
 
            old_bus_name = (dbus.service.BusName
2521
 
                            ("se.bsnet.fukt.Mandos", bus,
2522
 
                             do_not_queue=True))
2523
 
        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:
2524
3059
            logger.error("Disabling D-Bus:", exc_info=e)
2525
3060
            use_dbus = False
2526
3061
            server_settings["use_dbus"] = False
2527
3062
            tcp_server.use_dbus = False
2528
3063
    if zeroconf:
2529
3064
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2530
 
        service = AvahiServiceToSyslog(name =
2531
 
                                       server_settings["servicename"],
2532
 
                                       servicetype = "_mandos._tcp",
2533
 
                                       protocol = protocol, bus = bus)
 
3065
        service = AvahiServiceToSyslog(
 
3066
            name=server_settings["servicename"],
 
3067
            servicetype="_mandos._tcp",
 
3068
            protocol=protocol,
 
3069
            bus=bus)
2534
3070
        if server_settings["interface"]:
2535
 
            service.interface = (if_nametoindex
2536
 
                                 (str(server_settings["interface"])))
2537
 
    
 
3071
            service.interface = if_nametoindex(
 
3072
                server_settings["interface"].encode("utf-8"))
 
3073
 
2538
3074
    global multiprocessing_manager
2539
3075
    multiprocessing_manager = multiprocessing.Manager()
2540
 
    
 
3076
 
2541
3077
    client_class = Client
2542
3078
    if use_dbus:
2543
 
        client_class = functools.partial(ClientDBus, bus = bus)
2544
 
    
 
3079
        client_class = functools.partial(ClientDBus, bus=bus)
 
3080
 
2545
3081
    client_settings = Client.config_parser(client_config)
2546
3082
    old_client_settings = {}
2547
3083
    clients_data = {}
2548
 
    
 
3084
 
2549
3085
    # This is used to redirect stdout and stderr for checker processes
2550
3086
    global wnull
2551
 
    wnull = open(os.devnull, "w") # A writable /dev/null
 
3087
    wnull = open(os.devnull, "w")  # A writable /dev/null
2552
3088
    # Only used if server is running in foreground but not in debug
2553
3089
    # mode
2554
3090
    if debug or not foreground:
2555
3091
        wnull.close()
2556
 
    
 
3092
 
2557
3093
    # Get client data and settings from last running state.
2558
3094
    if server_settings["restore"]:
2559
3095
        try:
2560
3096
            with open(stored_state_path, "rb") as stored_state:
2561
 
                clients_data, old_client_settings = (pickle.load
2562
 
                                                     (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"))
2563
3142
            os.remove(stored_state_path)
2564
3143
        except IOError as e:
2565
3144
            if e.errno == errno.ENOENT:
2566
 
                logger.warning("Could not load persistent state: {}"
2567
 
                                .format(os.strerror(e.errno)))
 
3145
                logger.warning("Could not load persistent state:"
 
3146
                               " {}".format(os.strerror(e.errno)))
2568
3147
            else:
2569
3148
                logger.critical("Could not load persistent state:",
2570
3149
                                exc_info=e)
2571
3150
                raise
2572
3151
        except EOFError as e:
2573
3152
            logger.warning("Could not load persistent state: "
2574
 
                           "EOFError:", exc_info=e)
2575
 
    
 
3153
                           "EOFError:",
 
3154
                           exc_info=e)
 
3155
 
2576
3156
    with PGPEngine() as pgp:
2577
3157
        for client_name, client in clients_data.items():
2578
3158
            # Skip removed clients
2579
3159
            if client_name not in client_settings:
2580
3160
                continue
2581
 
            
 
3161
 
2582
3162
            # Decide which value to use after restoring saved state.
2583
3163
            # We have three different values: Old config file,
2584
3164
            # new config file, and saved state.
2589
3169
                    # For each value in new config, check if it
2590
3170
                    # differs from the old config value (Except for
2591
3171
                    # the "secret" attribute)
2592
 
                    if (name != "secret" and
2593
 
                        value != old_client_settings[client_name]
2594
 
                        [name]):
 
3172
                    if (name != "secret"
 
3173
                        and (value !=
 
3174
                             old_client_settings[client_name][name])):
2595
3175
                        client[name] = value
2596
3176
                except KeyError:
2597
3177
                    pass
2598
 
            
 
3178
 
2599
3179
            # Clients who has passed its expire date can still be
2600
 
            # enabled if its last checker was successful.  Clients
 
3180
            # enabled if its last checker was successful.  A Client
2601
3181
            # whose checker succeeded before we stored its state is
2602
3182
            # assumed to have successfully run all checkers during
2603
3183
            # downtime.
2606
3186
                    if not client["last_checked_ok"]:
2607
3187
                        logger.warning(
2608
3188
                            "disabling client {} - Client never "
2609
 
                            "performed a successful checker"
2610
 
                            .format(client_name))
 
3189
                            "performed a successful checker".format(
 
3190
                                client_name))
2611
3191
                        client["enabled"] = False
2612
3192
                    elif client["last_checker_status"] != 0:
2613
3193
                        logger.warning(
2614
3194
                            "disabling client {} - Client last"
2615
 
                            " checker failed with error code {}"
2616
 
                            .format(client_name,
2617
 
                                    client["last_checker_status"]))
 
3195
                            " checker failed with error code"
 
3196
                            " {}".format(
 
3197
                                client_name,
 
3198
                                client["last_checker_status"]))
2618
3199
                        client["enabled"] = False
2619
3200
                    else:
2620
 
                        client["expires"] = (datetime.datetime
2621
 
                                             .utcnow()
2622
 
                                             + client["timeout"])
 
3201
                        client["expires"] = (
 
3202
                            datetime.datetime.utcnow()
 
3203
                            + client["timeout"])
2623
3204
                        logger.debug("Last checker succeeded,"
2624
 
                                     " keeping {} enabled"
2625
 
                                     .format(client_name))
 
3205
                                     " keeping {} enabled".format(
 
3206
                                         client_name))
2626
3207
            try:
2627
 
                client["secret"] = (
2628
 
                    pgp.decrypt(client["encrypted_secret"],
2629
 
                                client_settings[client_name]
2630
 
                                ["secret"]))
 
3208
                client["secret"] = pgp.decrypt(
 
3209
                    client["encrypted_secret"],
 
3210
                    client_settings[client_name]["secret"])
2631
3211
            except PGPError:
2632
3212
                # If decryption fails, we use secret from new settings
2633
 
                logger.debug("Failed to decrypt {} old secret"
2634
 
                             .format(client_name))
2635
 
                client["secret"] = (
2636
 
                    client_settings[client_name]["secret"])
2637
 
    
 
3213
                logger.debug("Failed to decrypt {} old secret".format(
 
3214
                    client_name))
 
3215
                client["secret"] = (client_settings[client_name]
 
3216
                                    ["secret"])
 
3217
 
2638
3218
    # Add/remove clients based on new changes made to config
2639
3219
    for client_name in (set(old_client_settings)
2640
3220
                        - set(client_settings)):
2642
3222
    for client_name in (set(client_settings)
2643
3223
                        - set(old_client_settings)):
2644
3224
        clients_data[client_name] = client_settings[client_name]
2645
 
    
 
3225
 
2646
3226
    # Create all client objects
2647
3227
    for client_name, client in clients_data.items():
2648
3228
        tcp_server.clients[client_name] = client_class(
2649
 
            name = client_name, settings = client,
2650
 
            server_settings = server_settings)
2651
 
    
 
3229
            name=client_name,
 
3230
            settings=client,
 
3231
            server_settings=server_settings)
 
3232
 
2652
3233
    if not tcp_server.clients:
2653
3234
        logger.warning("No clients defined")
2654
 
    
 
3235
 
2655
3236
    if not foreground:
2656
3237
        if pidfile is not None:
 
3238
            pid = os.getpid()
2657
3239
            try:
2658
3240
                with pidfile:
2659
 
                    pid = os.getpid()
2660
 
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
3241
                    print(pid, file=pidfile)
2661
3242
            except IOError:
2662
3243
                logger.error("Could not write to file %r with PID %d",
2663
3244
                             pidfilename, pid)
2664
3245
        del pidfile
2665
3246
        del pidfilename
2666
 
    
2667
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2668
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2669
 
    
 
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
 
2670
3252
    if use_dbus:
2671
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2672
 
                                        "se.bsnet.fukt.Mandos"})
2673
 
        class MandosDBusService(DBusObjectWithProperties):
 
3253
 
 
3254
        @alternate_dbus_interfaces(
 
3255
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3256
        class MandosDBusService(DBusObjectWithObjectManager):
2674
3257
            """A D-Bus proxy object"""
 
3258
 
2675
3259
            def __init__(self):
2676
3260
                dbus.service.Object.__init__(self, bus, "/")
 
3261
 
2677
3262
            _interface = "se.recompile.Mandos"
2678
 
            
2679
 
            @dbus_interface_annotations(_interface)
2680
 
            def _foo(self):
2681
 
                return { "org.freedesktop.DBus.Property"
2682
 
                         ".EmitsChangedSignal":
2683
 
                             "false"}
2684
 
            
 
3263
 
2685
3264
            @dbus.service.signal(_interface, signature="o")
2686
3265
            def ClientAdded(self, objpath):
2687
3266
                "D-Bus signal"
2688
3267
                pass
2689
 
            
 
3268
 
2690
3269
            @dbus.service.signal(_interface, signature="ss")
2691
3270
            def ClientNotFound(self, fingerprint, address):
2692
3271
                "D-Bus signal"
2693
3272
                pass
2694
 
            
 
3273
 
 
3274
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3275
                               "true"})
2695
3276
            @dbus.service.signal(_interface, signature="os")
2696
3277
            def ClientRemoved(self, objpath, name):
2697
3278
                "D-Bus signal"
2698
3279
                pass
2699
 
            
 
3280
 
 
3281
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3282
                               "true"})
2700
3283
            @dbus.service.method(_interface, out_signature="ao")
2701
3284
            def GetAllClients(self):
2702
3285
                "D-Bus method"
2703
 
                return dbus.Array(c.dbus_object_path
2704
 
                                  for c in
2705
 
                                  tcp_server.clients.itervalues())
2706
 
            
 
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"})
2707
3291
            @dbus.service.method(_interface,
2708
3292
                                 out_signature="a{oa{sv}}")
2709
3293
            def GetAllClientsWithProperties(self):
2710
3294
                "D-Bus method"
2711
3295
                return dbus.Dictionary(
2712
 
                    ((c.dbus_object_path, c.GetAll(""))
2713
 
                     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()},
2714
3299
                    signature="oa{sv}")
2715
 
            
 
3300
 
2716
3301
            @dbus.service.method(_interface, in_signature="o")
2717
3302
            def RemoveClient(self, object_path):
2718
3303
                "D-Bus method"
2719
 
                for c in tcp_server.clients.itervalues():
 
3304
                for c in tcp_server.clients.values():
2720
3305
                    if c.dbus_object_path == object_path:
2721
3306
                        del tcp_server.clients[c.name]
2722
3307
                        c.remove_from_connection()
2723
 
                        # Don't signal anything except ClientRemoved
 
3308
                        # Don't signal the disabling
2724
3309
                        c.disable(quiet=True)
2725
 
                        # Emit D-Bus signal
2726
 
                        self.ClientRemoved(object_path, c.name)
 
3310
                        # Emit D-Bus signal for removal
 
3311
                        self.client_removed_signal(c)
2727
3312
                        return
2728
3313
                raise KeyError(object_path)
2729
 
            
 
3314
 
2730
3315
            del _interface
2731
 
        
 
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
 
2732
3353
        mandos_dbus_service = MandosDBusService()
2733
 
    
 
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
 
2734
3360
    def cleanup():
2735
3361
        "Cleanup function; run on exit"
2736
3362
        if zeroconf:
2737
3363
            service.cleanup()
2738
 
        
2739
 
        multiprocessing.active_children()
2740
 
        wnull.close()
 
3364
 
 
3365
        mp.active_children()
 
3366
        wn.close()
2741
3367
        if not (tcp_server.clients or client_settings):
2742
3368
            return
2743
 
        
 
3369
 
2744
3370
        # Store client before exiting. Secrets are encrypted with key
2745
3371
        # based on what config file has. If config file is
2746
3372
        # removed/edited, old secret will thus be unrecovable.
2747
3373
        clients = {}
2748
3374
        with PGPEngine() as pgp:
2749
 
            for client in tcp_server.clients.itervalues():
 
3375
            for client in tcp_server.clients.values():
2750
3376
                key = client_settings[client.name]["secret"]
2751
3377
                client.encrypted_secret = pgp.encrypt(client.secret,
2752
3378
                                                      key)
2753
3379
                client_dict = {}
2754
 
                
 
3380
 
2755
3381
                # A list of attributes that can not be pickled
2756
3382
                # + secret.
2757
 
                exclude = { "bus", "changedstate", "secret",
2758
 
                            "checker", "server_settings" }
2759
 
                for name, typ in (inspect.getmembers
2760
 
                                  (dbus.service.Object)):
 
3383
                exclude = {"bus", "changedstate", "secret",
 
3384
                           "checker", "server_settings"}
 
3385
                for name, typ in inspect.getmembers(dbus.service
 
3386
                                                    .Object):
2761
3387
                    exclude.add(name)
2762
 
                
 
3388
 
2763
3389
                client_dict["encrypted_secret"] = (client
2764
3390
                                                   .encrypted_secret)
2765
3391
                for attr in client.client_structure:
2766
3392
                    if attr not in exclude:
2767
3393
                        client_dict[attr] = getattr(client, attr)
2768
 
                
 
3394
 
2769
3395
                clients[client.name] = client_dict
2770
3396
                del client_settings[client.name]["secret"]
2771
 
        
 
3397
 
2772
3398
        try:
2773
 
            with (tempfile.NamedTemporaryFile
2774
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2775
 
                   dir=os.path.dirname(stored_state_path),
2776
 
                   delete=False)) as stored_state:
2777
 
                pickle.dump((clients, client_settings), stored_state)
2778
 
                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
2779
3408
            os.rename(tempname, stored_state_path)
2780
3409
        except (IOError, OSError) as e:
2781
3410
            if not debug:
2790
3419
                logger.warning("Could not save persistent state:",
2791
3420
                               exc_info=e)
2792
3421
                raise
2793
 
        
 
3422
 
2794
3423
        # Delete all clients, and settings from config
2795
3424
        while tcp_server.clients:
2796
3425
            name, client = tcp_server.clients.popitem()
2797
3426
            if use_dbus:
2798
3427
                client.remove_from_connection()
2799
 
            # Don't signal anything except ClientRemoved
 
3428
            # Don't signal the disabling
2800
3429
            client.disable(quiet=True)
 
3430
            # Emit D-Bus signal for removal
2801
3431
            if use_dbus:
2802
 
                # Emit D-Bus signal
2803
 
                mandos_dbus_service.ClientRemoved(client
2804
 
                                                  .dbus_object_path,
2805
 
                                                  client.name)
 
3432
                mandos_dbus_service.client_removed_signal(client)
2806
3433
        client_settings.clear()
2807
 
    
 
3434
 
2808
3435
    atexit.register(cleanup)
2809
 
    
2810
 
    for client in tcp_server.clients.itervalues():
 
3436
 
 
3437
    for client in tcp_server.clients.values():
2811
3438
        if use_dbus:
2812
 
            # Emit D-Bus signal
2813
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3439
            # Emit D-Bus signal for adding
 
3440
            mandos_dbus_service.client_added_signal(client)
2814
3441
        # Need to initiate checking of clients
2815
3442
        if client.enabled:
2816
3443
            client.init_checker()
2817
 
    
 
3444
 
2818
3445
    tcp_server.enable()
2819
3446
    tcp_server.server_activate()
2820
 
    
 
3447
 
2821
3448
    # Find out what port we got
2822
3449
    if zeroconf:
2823
3450
        service.port = tcp_server.socket.getsockname()[1]
2828
3455
    else:                       # IPv4
2829
3456
        logger.info("Now listening on address %r, port %d",
2830
3457
                    *tcp_server.socket.getsockname())
2831
 
    
2832
 
    #service.interface = tcp_server.socket.getsockname()[3]
2833
 
    
 
3458
 
 
3459
    # service.interface = tcp_server.socket.getsockname()[3]
 
3460
 
2834
3461
    try:
2835
3462
        if zeroconf:
2836
3463
            # From the Avahi example code
2841
3468
                cleanup()
2842
3469
                sys.exit(1)
2843
3470
            # End of Avahi example code
2844
 
        
2845
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2846
 
                             lambda *args, **kwargs:
2847
 
                             (tcp_server.handle_request
2848
 
                              (*args[2:], **kwargs) or True))
2849
 
        
 
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
 
2850
3477
        logger.debug("Starting main loop")
2851
3478
        main_loop.run()
2852
3479
    except AvahiError as error:
2861
3488
    # Must run before the D-Bus bus name gets deregistered
2862
3489
    cleanup()
2863
3490
 
 
3491
 
2864
3492
if __name__ == '__main__':
2865
3493
    main()