/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at bsnet
  • Date: 2011-11-12 18:14:55 UTC
  • mto: This revision was merged to the branch mainline in revision 522.
  • Revision ID: teddy@fukt.bsnet.se-20111112181455-8m6z4qrrib33bl2c
* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
                                                 "--network-hook-dir"
                                                 option.

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