/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: 2014-06-06 02:29:14 UTC
  • Revision ID: teddy@recompile.se-20140606022914-qc2q0bg0rtus8s2g
Tags: version-1.6.5-3
* debian/changelog (1.6.5-3): New entry.

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