/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2018-02-10 13:23:58 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 362.
  • Revision ID: teddy@recompile.se-20180210132358-8pfvo9vshq9l32y5
Remove unnecessary text left from old example init.d file

* init.d-mandos: Remove unnecessary text left from old example init.d
  file.

Show diffs side-by-side

added added

removed removed

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