/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-07-25 22:44:36 UTC
  • Revision ID: teddy@recompile.se-20190725224436-19eyd06r7qmtowo6
Allow line breaks on long lines in plugin-runner manual

* debian/mandos-client.lintian-overrides
  (manpage-has-errors-from-man): Remove.
* plugin-runner.xml (EXAMPLE): Allow line breaks by adding ZERO WIDTH
                               SPACE characters.  Also correct
                               description of example command line.

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-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
 
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
19
21
# the Free Software Foundation, either version 3 of the License, or
20
22
# (at your option) any later version.
21
23
#
22
 
#     This program is distributed in the hope that it will be useful,
23
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
24
#     Mandos is distributed in the hope that it will be useful, but
 
25
#     WITHOUT ANY WARRANTY; without even the implied warranty of
24
26
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25
27
#     GNU General Public License for more details.
26
 
 
28
#
27
29
# You should have received a copy of the GNU General Public License
28
 
# along with this program.  If not, see
29
 
# <http://www.gnu.org/licenses/>.
30
 
 
30
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
31
#
31
32
# Contact the authors at <mandos@recompile.se>.
32
 
 
33
#
33
34
 
34
35
from __future__ import (division, absolute_import, print_function,
35
36
                        unicode_literals)
36
37
 
37
 
import SocketServer as socketserver
 
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
38
47
import socket
39
48
import argparse
40
49
import datetime
41
50
import errno
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
 
51
try:
 
52
    import ConfigParser as configparser
 
53
except ImportError:
 
54
    import configparser
49
55
import sys
50
56
import re
51
57
import os
60
66
import struct
61
67
import fcntl
62
68
import functools
63
 
import cPickle as pickle
 
69
try:
 
70
    import cPickle as pickle
 
71
except ImportError:
 
72
    import pickle
64
73
import multiprocessing
65
74
import types
66
 
import hashlib
 
75
import binascii
 
76
import tempfile
 
77
import itertools
 
78
import collections
 
79
import codecs
67
80
 
68
81
import dbus
69
82
import dbus.service
70
 
import gobject
71
 
import avahi
 
83
from gi.repository import GLib
72
84
from dbus.mainloop.glib import DBusGMainLoop
73
85
import ctypes
74
86
import ctypes.util
75
87
import xml.dom.minidom
76
88
import inspect
77
 
import Crypto.Cipher.AES
78
89
 
 
90
# Try to find the value of SO_BINDTODEVICE:
79
91
try:
 
92
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
 
93
    # newer, and it is also the most natural place for it:
80
94
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
81
95
except AttributeError:
82
96
    try:
 
97
        # This is where SO_BINDTODEVICE was up to and including Python
 
98
        # 2.6, and also 3.2:
83
99
        from IN import SO_BINDTODEVICE
84
100
    except ImportError:
85
 
        SO_BINDTODEVICE = None
86
 
 
87
 
 
88
 
version = "1.4.1"
 
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.4"
 
119
stored_state_file = "clients.pickle"
89
120
 
90
121
logger = logging.getLogger()
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)
 
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
107
301
 
108
302
 
109
303
class AvahiError(Exception):
110
304
    def __init__(self, value, *args, **kwargs):
111
305
        self.value = value
112
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
113
 
    def __unicode__(self):
114
 
        return unicode(repr(self.value))
 
306
        return super(AvahiError, self).__init__(value, *args,
 
307
                                                **kwargs)
 
308
 
115
309
 
116
310
class AvahiServiceError(AvahiError):
117
311
    pass
118
312
 
 
313
 
119
314
class AvahiGroupError(AvahiError):
120
315
    pass
121
316
 
122
317
 
123
318
class AvahiService(object):
124
319
    """An Avahi (Zeroconf) service.
125
 
    
 
320
 
126
321
    Attributes:
127
322
    interface: integer; avahi.IF_UNSPEC or an interface index.
128
323
               Used to optionally bind to the specified interface.
129
324
    name: string; Example: 'Mandos'
130
325
    type: string; Example: '_mandos._tcp'.
131
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
326
     See <https://www.iana.org/assignments/service-names-port-numbers>
132
327
    port: integer; what port to announce
133
328
    TXT: list of strings; TXT record for the service
134
329
    domain: string; Domain to publish on, default to .local if empty.
140
335
    server: D-Bus Server
141
336
    bus: dbus.SystemBus()
142
337
    """
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):
 
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):
147
350
        self.interface = interface
148
351
        self.name = name
149
352
        self.type = servicetype
158
361
        self.server = None
159
362
        self.bus = bus
160
363
        self.entry_group_state_changed_match = None
161
 
    def rename(self):
 
364
 
 
365
    def rename(self, remove=True):
162
366
        """Derived from the Avahi example code"""
163
367
        if self.rename_count >= self.max_renames:
164
368
            logger.critical("No suitable Zeroconf service name found"
165
369
                            " after %i retries, exiting.",
166
370
                            self.rename_count)
167
371
            raise AvahiServiceError("Too many renames")
168
 
        self.name = unicode(self.server
169
 
                            .GetAlternativeServiceName(self.name))
 
372
        self.name = str(
 
373
            self.server.GetAlternativeServiceName(self.name))
 
374
        self.rename_count += 1
170
375
        logger.info("Changing Zeroconf service name to %r ...",
171
376
                    self.name)
172
 
        self.remove()
 
377
        if remove:
 
378
            self.remove()
173
379
        try:
174
380
            self.add()
175
381
        except dbus.exceptions.DBusException as error:
176
 
            logger.critical("DBusException: %s", error)
177
 
            self.cleanup()
178
 
            os._exit(1)
179
 
        self.rename_count += 1
 
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
 
180
391
    def remove(self):
181
392
        """Derived from the Avahi example code"""
182
393
        if self.entry_group_state_changed_match is not None:
184
395
            self.entry_group_state_changed_match = None
185
396
        if self.group is not None:
186
397
            self.group.Reset()
 
398
 
187
399
    def add(self):
188
400
        """Derived from the Avahi example code"""
189
401
        self.remove()
206
418
            dbus.UInt16(self.port),
207
419
            avahi.string_array_to_txt_array(self.TXT))
208
420
        self.group.Commit()
 
421
 
209
422
    def entry_group_state_changed(self, state, error):
210
423
        """Derived from the Avahi example code"""
211
424
        logger.debug("Avahi entry group state change: %i", state)
212
 
        
 
425
 
213
426
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
214
427
            logger.debug("Zeroconf service established.")
215
428
        elif state == avahi.ENTRY_GROUP_COLLISION:
217
430
            self.rename()
218
431
        elif state == avahi.ENTRY_GROUP_FAILURE:
219
432
            logger.critical("Avahi: Error in group state changed %s",
220
 
                            unicode(error))
221
 
            raise AvahiGroupError("State changed: %s"
222
 
                                  % unicode(error))
 
433
                            str(error))
 
434
            raise AvahiGroupError("State changed: {!s}".format(error))
 
435
 
223
436
    def cleanup(self):
224
437
        """Derived from the Avahi example code"""
225
438
        if self.group is not None:
226
439
            try:
227
440
                self.group.Free()
228
441
            except (dbus.exceptions.UnknownMethodException,
229
 
                    dbus.exceptions.DBusException) as e:
 
442
                    dbus.exceptions.DBusException):
230
443
                pass
231
444
            self.group = None
232
445
        self.remove()
 
446
 
233
447
    def server_state_changed(self, state, error=None):
234
448
        """Derived from the Avahi example code"""
235
449
        logger.debug("Avahi server state change: %i", state)
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" }
 
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
        }
243
456
        if state in bad_states:
244
457
            if bad_states[state] is not None:
245
458
                if error is None:
248
461
                    logger.error(bad_states[state] + ": %r", error)
249
462
            self.cleanup()
250
463
        elif state == avahi.SERVER_RUNNING:
251
 
            self.add()
 
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)
252
476
        else:
253
477
            if error is None:
254
478
                logger.debug("Unknown state: %r", state)
255
479
            else:
256
480
                logger.debug("Unknown state: %r: %r", state, error)
 
481
 
257
482
    def activate(self):
258
483
        """Derived from the Avahi example code"""
259
484
        if self.server is None:
263
488
                                    follow_name_owner_changes=True),
264
489
                avahi.DBUS_INTERFACE_SERVER)
265
490
        self.server.connect_to_signal("StateChanged",
266
 
                                 self.server_state_changed)
 
491
                                      self.server_state_changed)
267
492
        self.server_state_changed(self.server.GetState())
268
493
 
 
494
 
269
495
class AvahiServiceToSyslog(AvahiService):
270
 
    def rename(self):
 
496
    def rename(self, *args, **kwargs):
271
497
        """Add the new name to the syslog messages"""
272
 
        ret = AvahiService.rename(self)
273
 
        syslogger.setFormatter(logging.Formatter
274
 
                               ('Mandos (%s) [%%(process)d]:'
275
 
                                ' %%(levelname)s: %%(message)s'
276
 
                                % self.name))
 
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)))
277
502
        return ret
278
503
 
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
 
        
 
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
 
285
817
class Client(object):
286
818
    """A representation of a client host served by this server.
287
 
    
 
819
 
288
820
    Attributes:
289
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
821
    approved:   bool(); 'None' if not yet approved/disapproved
290
822
    approval_delay: datetime.timedelta(); Time to wait for approval
291
823
    approval_duration: datetime.timedelta(); Duration of one approval
292
824
    checker:    subprocess.Popen(); a running checker process used
293
825
                                    to see if the client lives.
294
826
                                    'None' if no process is running.
295
 
    checker_callback_tag: a gobject event source tag, or None
 
827
    checker_callback_tag: a GLib event source tag, or None
296
828
    checker_command: string; External command which is run to check
297
829
                     if client lives.  %() expansions are done at
298
830
                     runtime with vars(self) as dict, so that for
299
831
                     instance %(name)s can be used in the command.
300
 
    checker_initiator_tag: a gobject event source tag, or None
 
832
    checker_initiator_tag: a GLib event source tag, or None
301
833
    created:    datetime.datetime(); (UTC) object creation
302
834
    client_structure: Object describing what attributes a client has
303
835
                      and is used for storing the client at exit
304
836
    current_checker_command: string; current running checker_command
305
 
    disable_initiator_tag: a gobject event source tag, or None
 
837
    disable_initiator_tag: a GLib event source tag, or None
306
838
    enabled:    bool()
307
839
    fingerprint: string (40 or 32 hexadecimal digits); used to
308
 
                 uniquely identify the client
 
840
                 uniquely identify an OpenPGP client
 
841
    key_id: string (64 hexadecimal digits); used to uniquely identify
 
842
            a client using raw public keys
309
843
    host:       string; available for use by the checker command
310
844
    interval:   datetime.timedelta(); How often to start a new checker
311
845
    last_approval_request: datetime.datetime(); (UTC) or None
312
846
    last_checked_ok: datetime.datetime(); (UTC) or None
313
847
    last_checker_status: integer between 0 and 255 reflecting exit
314
 
                         status of last checker. -1 reflect crashed
315
 
                         checker, or None.
316
 
    last_enabled: datetime.datetime(); (UTC)
 
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
317
853
    name:       string; from the config file, used in log messages and
318
854
                        D-Bus identifiers
319
855
    secret:     bytestring; sent verbatim (over TLS) to client
320
856
    timeout:    datetime.timedelta(); How long from last_checked_ok
321
857
                                      until this client is disabled
322
 
    extended_timeout:   extra long timeout when password has been sent
 
858
    extended_timeout:   extra long timeout when secret has been sent
323
859
    runtime_expansions: Allowed attributes for runtime expansion.
324
860
    expires:    datetime.datetime(); time (UTC) when a client will be
325
861
                disabled, or None
 
862
    server_settings: The server_settings dict from main()
326
863
    """
327
 
    
 
864
 
328
865
    runtime_expansions = ("approval_delay", "approval_duration",
329
 
                          "created", "enabled", "fingerprint",
330
 
                          "host", "interval", "last_checked_ok",
 
866
                          "created", "enabled", "expires", "key_id",
 
867
                          "fingerprint", "host", "interval",
 
868
                          "last_approval_request", "last_checked_ok",
331
869
                          "last_enabled", "name", "timeout")
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."""
 
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):
352
937
        self.name = name
353
 
        if config is None:
354
 
            config = {}
 
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
 
355
955
        logger.debug("Creating client %r", self.name)
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(" ", ""))
 
956
        logger.debug("  Key ID: %s", self.key_id)
361
957
        logger.debug("  Fingerprint: %s", self.fingerprint)
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"])
 
958
        self.created = settings.get("created",
 
959
                                    datetime.datetime.utcnow())
 
960
 
 
961
        # attributes specific for this server instance
383
962
        self.checker = None
384
963
        self.checker_initiator_tag = None
385
964
        self.disable_initiator_tag = None
386
 
        self.expires = datetime.datetime.utcnow() + self.timeout
387
965
        self.checker_callback_tag = None
388
 
        self.checker_command = config["checker"]
389
966
        self.current_checker_command = None
390
 
        self._approved = None
391
 
        self.approved_by_default = config.get("approved_by_default",
392
 
                                              True)
 
967
        self.approved = None
393
968
        self.approvals_pending = 0
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()
 
969
        self.changedstate = multiprocessing_manager.Condition(
 
970
            multiprocessing_manager.Lock())
 
971
        self.client_structure = [attr
 
972
                                 for attr in self.__dict__.keys()
403
973
                                 if not attr.startswith("_")]
404
974
        self.client_structure.append("client_structure")
405
975
 
406
 
 
407
 
        for name, t in inspect.getmembers(type(self),
408
 
                                          lambda obj:
409
 
                                              isinstance(obj,
410
 
                                                         property)):
 
976
        for name, t in inspect.getmembers(
 
977
                type(self), lambda obj: isinstance(obj, property)):
411
978
            if not name.startswith("_"):
412
979
                self.client_structure.append(name)
413
 
    
 
980
 
414
981
    # Send notice to process children that client state has changed
415
982
    def send_changedstate(self):
416
983
        with self.changedstate:
417
984
            self.changedstate.notify_all()
418
 
    
 
985
 
419
986
    def enable(self):
420
987
        """Start this client's checker and timeout hooks"""
421
988
        if getattr(self, "enabled", False):
422
989
            # Already enabled
423
990
            return
424
 
        self.send_changedstate()
425
991
        self.expires = datetime.datetime.utcnow() + self.timeout
426
992
        self.enabled = True
427
993
        self.last_enabled = datetime.datetime.utcnow()
428
994
        self.init_checker()
429
 
    
 
995
        self.send_changedstate()
 
996
 
430
997
    def disable(self, quiet=True):
431
998
        """Disable this client."""
432
999
        if not getattr(self, "enabled", False):
433
1000
            return False
434
1001
        if not quiet:
435
 
            self.send_changedstate()
436
 
        if not quiet:
437
1002
            logger.info("Disabling client %s", self.name)
438
 
        if getattr(self, "disable_initiator_tag", False):
439
 
            gobject.source_remove(self.disable_initiator_tag)
 
1003
        if getattr(self, "disable_initiator_tag", None) is not None:
 
1004
            GLib.source_remove(self.disable_initiator_tag)
440
1005
            self.disable_initiator_tag = None
441
1006
        self.expires = None
442
 
        if getattr(self, "checker_initiator_tag", False):
443
 
            gobject.source_remove(self.checker_initiator_tag)
 
1007
        if getattr(self, "checker_initiator_tag", None) is not None:
 
1008
            GLib.source_remove(self.checker_initiator_tag)
444
1009
            self.checker_initiator_tag = None
445
1010
        self.stop_checker()
446
1011
        self.enabled = False
447
 
        # Do not run this again if called by a gobject.timeout_add
 
1012
        if not quiet:
 
1013
            self.send_changedstate()
 
1014
        # Do not run this again if called by a GLib.timeout_add
448
1015
        return False
449
 
    
 
1016
 
450
1017
    def __del__(self):
451
1018
        self.disable()
452
1019
 
453
1020
    def init_checker(self):
454
1021
        # Schedule a new checker to be started an 'interval' from now,
455
1022
        # and every interval from then on.
456
 
        self.checker_initiator_tag = (gobject.timeout_add
457
 
                                      (self.interval_milliseconds(),
458
 
                                       self.start_checker))
 
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)
459
1028
        # Schedule a disable() when 'timeout' has passed
460
 
        self.disable_initiator_tag = (gobject.timeout_add
461
 
                                   (self.timeout_milliseconds(),
462
 
                                    self.disable))
 
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)
463
1033
        # Also start a new checker *right now*.
464
1034
        self.start_checker()
465
1035
 
466
 
        
467
 
    def checker_callback(self, pid, condition, command):
 
1036
    def checker_callback(self, source, condition, connection,
 
1037
                         command):
468
1038
        """The checker has completed, so take appropriate actions."""
469
1039
        self.checker_callback_tag = None
470
1040
        self.checker = None
471
 
        if os.WIFEXITED(condition):
472
 
            self.last_checker_status =  os.WEXITSTATUS(condition)
 
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
473
1048
            if self.last_checker_status == 0:
474
1049
                logger.info("Checker for %(name)s succeeded",
475
1050
                            vars(self))
476
1051
                self.checked_ok()
477
1052
            else:
478
 
                logger.info("Checker for %(name)s failed",
479
 
                            vars(self))
 
1053
                logger.info("Checker for %(name)s failed", vars(self))
480
1054
        else:
481
1055
            self.last_checker_status = -1
 
1056
            self.last_checker_signal = -returncode
482
1057
            logger.warning("Checker for %(name)s crashed?",
483
1058
                           vars(self))
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
 
        """
 
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."""
491
1070
        if timeout is None:
492
1071
            timeout = self.timeout
493
 
        self.last_checked_ok = datetime.datetime.utcnow()
494
1072
        if self.disable_initiator_tag is not None:
495
 
            gobject.source_remove(self.disable_initiator_tag)
 
1073
            GLib.source_remove(self.disable_initiator_tag)
 
1074
            self.disable_initiator_tag = None
496
1075
        if getattr(self, "enabled", False):
497
 
            self.disable_initiator_tag = (gobject.timeout_add
498
 
                                          (_timedelta_to_milliseconds
499
 
                                           (timeout), self.disable))
 
1076
            self.disable_initiator_tag = GLib.timeout_add(
 
1077
                int(timeout.total_seconds() * 1000), self.disable)
500
1078
            self.expires = datetime.datetime.utcnow() + timeout
501
 
    
 
1079
 
502
1080
    def need_approval(self):
503
1081
        self.last_approval_request = datetime.datetime.utcnow()
504
 
    
 
1082
 
505
1083
    def start_checker(self):
506
1084
        """Start a new checker subprocess if one is not running.
507
 
        
 
1085
 
508
1086
        If a checker already exists, leave it running and do
509
1087
        nothing."""
510
1088
        # The reason for not killing a running checker is that if we
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
 
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
515
1093
        # checkers alone, the checker would have to take more time
516
1094
        # than 'timeout' for the client to be disabled, which is as it
517
1095
        # should be.
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)
 
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
532
1101
        # Start a new checker if needed
533
1102
        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}
534
1107
            try:
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
 
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
553
1114
            self.current_checker_command = command
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
 
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
578
1141
        return True
579
 
    
 
1142
 
580
1143
    def stop_checker(self):
581
1144
        """Force the checker process, if any, to stop."""
582
1145
        if self.checker_callback_tag:
583
 
            gobject.source_remove(self.checker_callback_tag)
 
1146
            GLib.source_remove(self.checker_callback_tag)
584
1147
            self.checker_callback_tag = None
585
1148
        if getattr(self, "checker", None) is None:
586
1149
            return
587
1150
        logger.debug("Stopping checker for %(name)s", vars(self))
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
 
1151
        self.checker.terminate()
596
1152
        self.checker = None
597
1153
 
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):
 
1154
 
 
1155
def dbus_service_property(dbus_interface,
 
1156
                          signature="v",
 
1157
                          access="readwrite",
 
1158
                          byte_arrays=False):
651
1159
    """Decorators for marking methods of a DBusObjectWithProperties to
652
1160
    become properties on the D-Bus.
653
 
    
 
1161
 
654
1162
    The decorated method will be called with no arguments by "Get"
655
1163
    and with one argument by "Set".
656
 
    
 
1164
 
657
1165
    The parameters, where they are supported, are the same as
658
1166
    dbus.service.method, except there is only "signature", since the
659
1167
    type from Get() and the type sent to Set() is the same.
662
1170
    # "Set" method, so we fail early here:
663
1171
    if byte_arrays and signature != "ay":
664
1172
        raise ValueError("Byte arrays not supported for non-'ay'"
665
 
                         " signature %r" % signature)
 
1173
                         " signature {!r}".format(signature))
 
1174
 
666
1175
    def decorator(func):
667
1176
        func._dbus_is_property = True
668
1177
        func._dbus_interface = dbus_interface
671
1180
        func._dbus_name = func.__name__
672
1181
        if func._dbus_name.endswith("_dbus_property"):
673
1182
            func._dbus_name = func._dbus_name[:-14]
674
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
675
 
        return func
 
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
 
676
1229
    return decorator
677
1230
 
678
1231
 
679
1232
class DBusPropertyException(dbus.exceptions.DBusException):
680
1233
    """A base class for D-Bus property-related exceptions
681
1234
    """
682
 
    def __unicode__(self):
683
 
        return unicode(str(self))
 
1235
    pass
684
1236
 
685
1237
 
686
1238
class DBusPropertyAccessException(DBusPropertyException):
695
1247
    pass
696
1248
 
697
1249
 
698
 
class DBusObjectWithProperties(dbus.service.Object):
 
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):
699
1340
    """A D-Bus object with properties.
700
 
    
 
1341
 
701
1342
    Classes inheriting from this can use the dbus_service_property
702
1343
    decorator to expose methods as D-Bus properties.  It exposes the
703
1344
    standard Get(), Set(), and GetAll() methods on the D-Bus.
704
1345
    """
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
 
    
 
1346
 
718
1347
    def _get_dbus_property(self, interface_name, property_name):
719
1348
        """Returns a bound method if one exists which is a D-Bus
720
1349
        property with the specified name and interface.
721
1350
        """
722
 
        for cls in  self.__class__.__mro__:
723
 
            for name, value in (inspect.getmembers
724
 
                                (cls, self._is_dbus_property)):
 
1351
        for cls in self.__class__.__mro__:
 
1352
            for name, value in inspect.getmembers(
 
1353
                    cls, self._is_dbus_thing("property")):
725
1354
                if (value._dbus_name == property_name
726
1355
                    and value._dbus_interface == interface_name):
727
1356
                    return value.__get__(self)
728
 
        
 
1357
 
729
1358
        # No such property
730
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
731
 
                                   + interface_name + "."
732
 
                                   + property_name)
733
 
    
734
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
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",
735
1373
                         out_signature="v")
736
1374
    def Get(self, interface_name, property_name):
737
1375
        """Standard D-Bus property Get() method, see D-Bus standard.
743
1381
        if not hasattr(value, "variant_level"):
744
1382
            return value
745
1383
        return type(value)(value, variant_level=value.variant_level+1)
746
 
    
 
1384
 
747
1385
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
748
1386
    def Set(self, interface_name, property_name, value):
749
1387
        """Standard D-Bus property Set() method, see D-Bus standard.
755
1393
            # The byte_arrays option is not supported yet on
756
1394
            # signatures other than "ay".
757
1395
            if prop._dbus_signature != "ay":
758
 
                raise ValueError
759
 
            value = dbus.ByteArray(''.join(unichr(byte)
760
 
                                           for byte in value))
 
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))
761
1401
        prop(value)
762
 
    
763
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1402
 
 
1403
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1404
                         in_signature="s",
764
1405
                         out_signature="a{sv}")
765
1406
    def GetAll(self, interface_name):
766
1407
        """Standard D-Bus property GetAll() method, see D-Bus
767
1408
        standard.
768
 
        
 
1409
 
769
1410
        Note: Will not include properties with access="write".
770
1411
        """
771
 
        all = {}
772
 
        for name, prop in self._get_all_dbus_properties():
 
1412
        properties = {}
 
1413
        for name, prop in self._get_all_dbus_things("property"):
773
1414
            if (interface_name
774
1415
                and interface_name != prop._dbus_interface):
775
1416
                # Interface non-empty but did not match
779
1420
                continue
780
1421
            value = prop()
781
1422
            if not hasattr(value, "variant_level"):
782
 
                all[name] = value
 
1423
                properties[name] = value
783
1424
                continue
784
 
            all[name] = type(value)(value, variant_level=
785
 
                                    value.variant_level+1)
786
 
        return dbus.Dictionary(all, signature="sv")
787
 
    
 
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
 
788
1437
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
789
1438
                         out_signature="s",
790
1439
                         path_keyword='object_path',
791
1440
                         connection_keyword='connection')
792
1441
    def Introspect(self, object_path, connection):
793
 
        """Standard D-Bus method, overloaded to insert property tags.
 
1442
        """Overloading of standard D-Bus method.
 
1443
 
 
1444
        Inserts property tags and interface annotation tags.
794
1445
        """
795
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
796
 
                                                   connection)
 
1446
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1447
                                                         object_path,
 
1448
                                                         connection)
797
1449
        try:
798
1450
            document = xml.dom.minidom.parseString(xmlstring)
 
1451
 
799
1452
            def make_tag(document, name, prop):
800
1453
                e = document.createElement("property")
801
1454
                e.setAttribute("name", name)
802
1455
                e.setAttribute("type", prop._dbus_signature)
803
1456
                e.setAttribute("access", prop._dbus_access)
804
1457
                return e
 
1458
 
805
1459
            for if_tag in document.getElementsByTagName("interface"):
 
1460
                # Add property tags
806
1461
                for tag in (make_tag(document, name, prop)
807
1462
                            for name, prop
808
 
                            in self._get_all_dbus_properties()
 
1463
                            in self._get_all_dbus_things("property")
809
1464
                            if prop._dbus_interface
810
1465
                            == if_tag.getAttribute("name")):
811
1466
                    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)
812
1483
                # Add the names to the return values for the
813
1484
                # "org.freedesktop.DBus.Properties" methods
814
1485
                if (if_tag.getAttribute("name")
829
1500
        except (AttributeError, xml.dom.DOMException,
830
1501
                xml.parsers.expat.ExpatError) as error:
831
1502
            logger.error("Failed to override Introspection method",
832
 
                         error)
833
 
        return xmlstring
834
 
 
835
 
 
836
 
def datetime_to_dbus (dt, variant_level=0):
 
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):
837
1579
    """Convert a UTC datetime.datetime() to a D-Bus type."""
838
1580
    if dt is None:
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.
 
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).
847
1607
    """
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):
 
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):
855
1616
                # Ignore non-D-Bus attributes, and D-Bus attributes
856
1617
                # with the wrong interface name
857
1618
                if (not hasattr(attribute, "_dbus_interface")
858
 
                    or not attribute._dbus_interface
859
 
                    .startswith("se.recompile.Mandos")):
 
1619
                    or not attribute._dbus_interface.startswith(
 
1620
                        orig_interface_name)):
860
1621
                    continue
861
1622
                # Create an alternate D-Bus interface name based on
862
1623
                # the current name
863
 
                alt_interface = (attribute._dbus_interface
864
 
                                 .replace("se.recompile.Mandos",
865
 
                                          "se.bsnet.fukt.Mandos"))
 
1624
                alt_interface = attribute._dbus_interface.replace(
 
1625
                    orig_interface_name, alt_interface_name)
 
1626
                interface_names.add(alt_interface)
866
1627
                # Is this a D-Bus signal?
867
1628
                if getattr(attribute, "_dbus_is_signal", False):
868
 
                    # Extract the original non-method function by
869
 
                    # black magic
870
 
                    nonmethod_func = (dict(
 
1629
                    # Extract the original non-method undecorated
 
1630
                    # function by black magic
 
1631
                    if sys.version_info.major == 2:
 
1632
                        nonmethod_func = (dict(
871
1633
                            zip(attribute.func_code.co_freevars,
872
 
                                attribute.__closure__))["func"]
873
 
                                      .cell_contents)
 
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)
874
1641
                    # Create a new, but exactly alike, function
875
1642
                    # object, and decorate it to be a new D-Bus signal
876
1643
                    # with the alternate D-Bus interface name
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)))
 
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
 
886
1655
                    # Define a creator of a function to call both the
887
 
                    # old and new functions, so both the old and new
888
 
                    # signals gets sent when the function is called
 
1656
                    # original and alternate functions, so both the
 
1657
                    # original and alternate signals gets sent when
 
1658
                    # the function is called
889
1659
                    def fixscope(func1, func2):
890
1660
                        """This function is a scope container to pass
891
1661
                        func1 and func2 to the "call_both" function
892
1662
                        outside of its arguments"""
 
1663
 
 
1664
                        @functools.wraps(func2)
893
1665
                        def call_both(*args, **kwargs):
894
1666
                            """This function will emit two D-Bus
895
1667
                            signals by calling func1 and func2"""
896
1668
                            func1(*args, **kwargs)
897
1669
                            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
 
898
1676
                        return call_both
899
1677
                    # Create the "call_both" function and add it to
900
1678
                    # the class
901
 
                    attr[attrname] = fixscope(attribute,
902
 
                                              new_function)
 
1679
                    attr[attrname] = fixscope(attribute, new_function)
903
1680
                # Is this a D-Bus method?
904
1681
                elif getattr(attribute, "_dbus_is_method", False):
905
1682
                    # Create a new, but exactly alike, function
906
1683
                    # object.  Decorate it to be a new D-Bus method
907
1684
                    # with the alternate D-Bus interface name.  Add it
908
1685
                    # to the class.
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)))
 
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
919
1698
                # Is this a D-Bus property?
920
1699
                elif getattr(attribute, "_dbus_is_property", False):
921
1700
                    # Create a new, but exactly alike, function
922
1701
                    # object, and decorate it to be a new D-Bus
923
1702
                    # property with the alternate D-Bus interface
924
1703
                    # name.  Add it to the class.
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
 
 
 
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"})
940
1756
class ClientDBus(Client, DBusObjectWithProperties):
941
1757
    """A Client class using D-Bus
942
 
    
 
1758
 
943
1759
    Attributes:
944
1760
    dbus_object_path: dbus.ObjectPath
945
1761
    bus: dbus.SystemBus()
946
1762
    """
947
 
    
 
1763
 
948
1764
    runtime_expansions = (Client.runtime_expansions
949
 
                          + ("dbus_object_path",))
950
 
    
 
1765
                          + ("dbus_object_path", ))
 
1766
 
 
1767
    _interface = "se.recompile.Mandos.Client"
 
1768
 
951
1769
    # dbus.service.Object doesn't use super(), so we can't either.
952
 
    
953
 
    def __init__(self, bus = None, *args, **kwargs):
 
1770
 
 
1771
    def __init__(self, bus=None, *args, **kwargs):
954
1772
        self.bus = bus
955
 
        self._approvals_pending = 0
956
1773
        Client.__init__(self, *args, **kwargs)
957
 
        self.add_to_dbus()
958
 
    
959
 
    def add_to_dbus(self):
960
1774
        # Only now, when this client is initialized, can it show up on
961
1775
        # the D-Bus
962
 
        client_object_name = unicode(self.name).translate(
 
1776
        client_object_name = str(self.name).translate(
963
1777
            {ord("."): ord("_"),
964
1778
             ord("-"): ord("_")})
965
 
        self.dbus_object_path = (dbus.ObjectPath
966
 
                                 ("/clients/" + client_object_name))
 
1779
        self.dbus_object_path = dbus.ObjectPath(
 
1780
            "/clients/" + client_object_name)
967
1781
        DBusObjectWithProperties.__init__(self, self.bus,
968
1782
                                          self.dbus_object_path)
969
 
        
970
 
    def notifychangeproperty(transform_func,
971
 
                             dbus_name, type_func=lambda x: x,
972
 
                             variant_level=1):
 
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):
973
1789
        """ Modify a variable so that it's a property which announces
974
1790
        its changes to DBus.
975
1791
 
980
1796
                   to the D-Bus.  Default: no transform
981
1797
        variant_level: D-Bus variant level.  Default: 1
982
1798
        """
983
 
        attrname = "_{0}".format(dbus_name)
 
1799
        attrname = "_{}".format(dbus_name)
 
1800
 
984
1801
        def setter(self, value):
985
1802
            if hasattr(self, "dbus_object_path"):
986
1803
                if (not hasattr(self, attrname) or
987
1804
                    type_func(getattr(self, attrname, None))
988
1805
                    != type_func(value)):
989
 
                    dbus_value = transform_func(type_func(value),
990
 
                                                variant_level
991
 
                                                =variant_level)
992
 
                    self.PropertyChanged(dbus.String(dbus_name),
993
 
                                         dbus_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())
994
1821
            setattr(self, attrname, value)
995
 
        
 
1822
 
996
1823
        return property(lambda self: getattr(self, attrname), setter)
997
 
    
998
 
    
 
1824
 
999
1825
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1000
1826
    approvals_pending = notifychangeproperty(dbus.Boolean,
1001
1827
                                             "ApprovalPending",
1002
 
                                             type_func = bool)
 
1828
                                             type_func=bool)
1003
1829
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1004
1830
    last_enabled = notifychangeproperty(datetime_to_dbus,
1005
1831
                                        "LastEnabled")
1006
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1007
 
                                   type_func = lambda checker:
1008
 
                                       checker is not None)
 
1832
    checker = notifychangeproperty(
 
1833
        dbus.Boolean, "CheckerRunning",
 
1834
        type_func=lambda checker: checker is not None)
1009
1835
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1010
1836
                                           "LastCheckedOK")
 
1837
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1838
                                               "LastCheckerStatus")
1011
1839
    last_approval_request = notifychangeproperty(
1012
1840
        datetime_to_dbus, "LastApprovalRequest")
1013
1841
    approved_by_default = notifychangeproperty(dbus.Boolean,
1014
1842
                                               "ApprovedByDefault")
1015
 
    approval_delay = notifychangeproperty(dbus.UInt16,
1016
 
                                          "ApprovalDelay",
1017
 
                                          type_func =
1018
 
                                          _timedelta_to_milliseconds)
 
1843
    approval_delay = notifychangeproperty(
 
1844
        dbus.UInt64, "ApprovalDelay",
 
1845
        type_func=lambda td: td.total_seconds() * 1000)
1019
1846
    approval_duration = notifychangeproperty(
1020
 
        dbus.UInt16, "ApprovalDuration",
1021
 
        type_func = _timedelta_to_milliseconds)
 
1847
        dbus.UInt64, "ApprovalDuration",
 
1848
        type_func=lambda td: td.total_seconds() * 1000)
1022
1849
    host = notifychangeproperty(dbus.String, "Host")
1023
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1024
 
                                   type_func =
1025
 
                                   _timedelta_to_milliseconds)
 
1850
    timeout = notifychangeproperty(
 
1851
        dbus.UInt64, "Timeout",
 
1852
        type_func=lambda td: td.total_seconds() * 1000)
1026
1853
    extended_timeout = notifychangeproperty(
1027
 
        dbus.UInt16, "ExtendedTimeout",
1028
 
        type_func = _timedelta_to_milliseconds)
1029
 
    interval = notifychangeproperty(dbus.UInt16,
1030
 
                                    "Interval",
1031
 
                                    type_func =
1032
 
                                    _timedelta_to_milliseconds)
 
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)
1033
1859
    checker_command = notifychangeproperty(dbus.String, "Checker")
1034
 
    
 
1860
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1861
                                  invalidate_only=True)
 
1862
 
1035
1863
    del notifychangeproperty
1036
 
    
 
1864
 
1037
1865
    def __del__(self, *args, **kwargs):
1038
1866
        try:
1039
1867
            self.remove_from_connection()
1042
1870
        if hasattr(DBusObjectWithProperties, "__del__"):
1043
1871
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1044
1872
        Client.__del__(self, *args, **kwargs)
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)
 
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:
1052
1881
            # Emit D-Bus signal
1053
1882
            self.CheckerCompleted(dbus.Int16(exitstatus),
1054
 
                                  dbus.Int64(condition),
 
1883
                                  # This is specific to GNU libC
 
1884
                                  dbus.Int64(exitstatus << 8),
1055
1885
                                  dbus.String(command))
1056
1886
        else:
1057
1887
            # Emit D-Bus signal
1058
1888
            self.CheckerCompleted(dbus.Int16(-1),
1059
 
                                  dbus.Int64(condition),
 
1889
                                  dbus.Int64(
 
1890
                                      # This is specific to GNU libC
 
1891
                                      (exitstatus << 8)
 
1892
                                      | self.last_checker_signal),
1060
1893
                                  dbus.String(command))
1061
 
        
1062
 
        return Client.checker_callback(self, pid, condition, command,
1063
 
                                       *args, **kwargs)
1064
 
    
 
1894
        return ret
 
1895
 
1065
1896
    def start_checker(self, *args, **kwargs):
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
 
1897
        old_checker_pid = getattr(self.checker, "pid", None)
1071
1898
        r = Client.start_checker(self, *args, **kwargs)
1072
1899
        # Only if new checker process was started
1073
1900
        if (self.checker is not None
1075
1902
            # Emit D-Bus signal
1076
1903
            self.CheckerStarted(self.current_checker_command)
1077
1904
        return r
1078
 
    
 
1905
 
1079
1906
    def _reset_approved(self):
1080
 
        self._approved = None
 
1907
        self.approved = None
1081
1908
        return False
1082
 
    
 
1909
 
1083
1910
    def approve(self, value=True):
 
1911
        self.approved = value
 
1912
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1913
                             * 1000), self._reset_approved)
1084
1914
        self.send_changedstate()
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
 
    
 
1915
 
 
1916
    #  D-Bus methods, signals & properties
 
1917
 
 
1918
    #  Interfaces
 
1919
 
 
1920
    #  Signals
 
1921
 
1096
1922
    # CheckerCompleted - signal
1097
1923
    @dbus.service.signal(_interface, signature="nxs")
1098
1924
    def CheckerCompleted(self, exitcode, waitstatus, command):
1099
1925
        "D-Bus signal"
1100
1926
        pass
1101
 
    
 
1927
 
1102
1928
    # CheckerStarted - signal
1103
1929
    @dbus.service.signal(_interface, signature="s")
1104
1930
    def CheckerStarted(self, command):
1105
1931
        "D-Bus signal"
1106
1932
        pass
1107
 
    
 
1933
 
1108
1934
    # PropertyChanged - signal
 
1935
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1109
1936
    @dbus.service.signal(_interface, signature="sv")
1110
1937
    def PropertyChanged(self, property, value):
1111
1938
        "D-Bus signal"
1112
1939
        pass
1113
 
    
 
1940
 
1114
1941
    # GotSecret - signal
1115
1942
    @dbus.service.signal(_interface)
1116
1943
    def GotSecret(self):
1119
1946
        server to mandos-client
1120
1947
        """
1121
1948
        pass
1122
 
    
 
1949
 
1123
1950
    # Rejected - signal
1124
1951
    @dbus.service.signal(_interface, signature="s")
1125
1952
    def Rejected(self, reason):
1126
1953
        "D-Bus signal"
1127
1954
        pass
1128
 
    
 
1955
 
1129
1956
    # NeedApproval - signal
1130
1957
    @dbus.service.signal(_interface, signature="tb")
1131
1958
    def NeedApproval(self, timeout, default):
1132
1959
        "D-Bus signal"
1133
1960
        return self.need_approval()
1134
 
    
1135
 
    ## Methods
1136
 
    
 
1961
 
 
1962
    #  Methods
 
1963
 
1137
1964
    # Approve - method
1138
1965
    @dbus.service.method(_interface, in_signature="b")
1139
1966
    def Approve(self, value):
1140
1967
        self.approve(value)
1141
 
    
 
1968
 
1142
1969
    # CheckedOK - method
1143
1970
    @dbus.service.method(_interface)
1144
1971
    def CheckedOK(self):
1145
1972
        self.checked_ok()
1146
 
    
 
1973
 
1147
1974
    # Enable - method
 
1975
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1148
1976
    @dbus.service.method(_interface)
1149
1977
    def Enable(self):
1150
1978
        "D-Bus method"
1151
1979
        self.enable()
1152
 
    
 
1980
 
1153
1981
    # StartChecker - method
 
1982
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1154
1983
    @dbus.service.method(_interface)
1155
1984
    def StartChecker(self):
1156
1985
        "D-Bus method"
1157
1986
        self.start_checker()
1158
 
    
 
1987
 
1159
1988
    # Disable - method
 
1989
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1160
1990
    @dbus.service.method(_interface)
1161
1991
    def Disable(self):
1162
1992
        "D-Bus method"
1163
1993
        self.disable()
1164
 
    
 
1994
 
1165
1995
    # StopChecker - method
 
1996
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1166
1997
    @dbus.service.method(_interface)
1167
1998
    def StopChecker(self):
1168
1999
        self.stop_checker()
1169
 
    
1170
 
    ## Properties
1171
 
    
 
2000
 
 
2001
    #  Properties
 
2002
 
1172
2003
    # ApprovalPending - property
1173
2004
    @dbus_service_property(_interface, signature="b", access="read")
1174
2005
    def ApprovalPending_dbus_property(self):
1175
2006
        return dbus.Boolean(bool(self.approvals_pending))
1176
 
    
 
2007
 
1177
2008
    # ApprovedByDefault - property
1178
 
    @dbus_service_property(_interface, signature="b",
 
2009
    @dbus_service_property(_interface,
 
2010
                           signature="b",
1179
2011
                           access="readwrite")
1180
2012
    def ApprovedByDefault_dbus_property(self, value=None):
1181
2013
        if value is None:       # get
1182
2014
            return dbus.Boolean(self.approved_by_default)
1183
2015
        self.approved_by_default = bool(value)
1184
 
    
 
2016
 
1185
2017
    # ApprovalDelay - property
1186
 
    @dbus_service_property(_interface, signature="t",
 
2018
    @dbus_service_property(_interface,
 
2019
                           signature="t",
1187
2020
                           access="readwrite")
1188
2021
    def ApprovalDelay_dbus_property(self, value=None):
1189
2022
        if value is None:       # get
1190
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
2023
            return dbus.UInt64(self.approval_delay.total_seconds()
 
2024
                               * 1000)
1191
2025
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1192
 
    
 
2026
 
1193
2027
    # ApprovalDuration - property
1194
 
    @dbus_service_property(_interface, signature="t",
 
2028
    @dbus_service_property(_interface,
 
2029
                           signature="t",
1195
2030
                           access="readwrite")
1196
2031
    def ApprovalDuration_dbus_property(self, value=None):
1197
2032
        if value is None:       # get
1198
 
            return dbus.UInt64(_timedelta_to_milliseconds(
1199
 
                    self.approval_duration))
 
2033
            return dbus.UInt64(self.approval_duration.total_seconds()
 
2034
                               * 1000)
1200
2035
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1201
 
    
 
2036
 
1202
2037
    # Name - property
 
2038
    @dbus_annotations(
 
2039
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1203
2040
    @dbus_service_property(_interface, signature="s", access="read")
1204
2041
    def Name_dbus_property(self):
1205
2042
        return dbus.String(self.name)
1206
 
    
 
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
 
1207
2051
    # Fingerprint - property
 
2052
    @dbus_annotations(
 
2053
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1208
2054
    @dbus_service_property(_interface, signature="s", access="read")
1209
2055
    def Fingerprint_dbus_property(self):
1210
2056
        return dbus.String(self.fingerprint)
1211
 
    
 
2057
 
1212
2058
    # Host - property
1213
 
    @dbus_service_property(_interface, signature="s",
 
2059
    @dbus_service_property(_interface,
 
2060
                           signature="s",
1214
2061
                           access="readwrite")
1215
2062
    def Host_dbus_property(self, value=None):
1216
2063
        if value is None:       # get
1217
2064
            return dbus.String(self.host)
1218
 
        self.host = value
1219
 
    
 
2065
        self.host = str(value)
 
2066
 
1220
2067
    # Created - property
 
2068
    @dbus_annotations(
 
2069
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1221
2070
    @dbus_service_property(_interface, signature="s", access="read")
1222
2071
    def Created_dbus_property(self):
1223
 
        return dbus.String(datetime_to_dbus(self.created))
1224
 
    
 
2072
        return datetime_to_dbus(self.created)
 
2073
 
1225
2074
    # LastEnabled - property
1226
2075
    @dbus_service_property(_interface, signature="s", access="read")
1227
2076
    def LastEnabled_dbus_property(self):
1228
2077
        return datetime_to_dbus(self.last_enabled)
1229
 
    
 
2078
 
1230
2079
    # Enabled - property
1231
 
    @dbus_service_property(_interface, signature="b",
 
2080
    @dbus_service_property(_interface,
 
2081
                           signature="b",
1232
2082
                           access="readwrite")
1233
2083
    def Enabled_dbus_property(self, value=None):
1234
2084
        if value is None:       # get
1237
2087
            self.enable()
1238
2088
        else:
1239
2089
            self.disable()
1240
 
    
 
2090
 
1241
2091
    # LastCheckedOK - property
1242
 
    @dbus_service_property(_interface, signature="s",
 
2092
    @dbus_service_property(_interface,
 
2093
                           signature="s",
1243
2094
                           access="readwrite")
1244
2095
    def LastCheckedOK_dbus_property(self, value=None):
1245
2096
        if value is not None:
1246
2097
            self.checked_ok()
1247
2098
            return
1248
2099
        return datetime_to_dbus(self.last_checked_ok)
1249
 
    
 
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
 
1250
2106
    # Expires - property
1251
2107
    @dbus_service_property(_interface, signature="s", access="read")
1252
2108
    def Expires_dbus_property(self):
1253
2109
        return datetime_to_dbus(self.expires)
1254
 
    
 
2110
 
1255
2111
    # LastApprovalRequest - property
1256
2112
    @dbus_service_property(_interface, signature="s", access="read")
1257
2113
    def LastApprovalRequest_dbus_property(self):
1258
2114
        return datetime_to_dbus(self.last_approval_request)
1259
 
    
 
2115
 
1260
2116
    # Timeout - property
1261
 
    @dbus_service_property(_interface, signature="t",
 
2117
    @dbus_service_property(_interface,
 
2118
                           signature="t",
1262
2119
                           access="readwrite")
1263
2120
    def Timeout_dbus_property(self, value=None):
1264
2121
        if value is None:       # get
1265
 
            return dbus.UInt64(self.timeout_milliseconds())
 
2122
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
2123
        old_timeout = self.timeout
1266
2124
        self.timeout = datetime.timedelta(0, 0, 0, value)
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
 
    
 
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
 
1288
2141
    # ExtendedTimeout - property
1289
 
    @dbus_service_property(_interface, signature="t",
 
2142
    @dbus_service_property(_interface,
 
2143
                           signature="t",
1290
2144
                           access="readwrite")
1291
2145
    def ExtendedTimeout_dbus_property(self, value=None):
1292
2146
        if value is None:       # get
1293
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
2147
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
2148
                               * 1000)
1294
2149
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1295
 
    
 
2150
 
1296
2151
    # Interval - property
1297
 
    @dbus_service_property(_interface, signature="t",
 
2152
    @dbus_service_property(_interface,
 
2153
                           signature="t",
1298
2154
                           access="readwrite")
1299
2155
    def Interval_dbus_property(self, value=None):
1300
2156
        if value is None:       # get
1301
 
            return dbus.UInt64(self.interval_milliseconds())
 
2157
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1302
2158
        self.interval = datetime.timedelta(0, 0, 0, value)
1303
2159
        if getattr(self, "checker_initiator_tag", None) is None:
1304
2160
            return
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
 
    
 
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
 
1311
2168
    # Checker - property
1312
 
    @dbus_service_property(_interface, signature="s",
 
2169
    @dbus_service_property(_interface,
 
2170
                           signature="s",
1313
2171
                           access="readwrite")
1314
2172
    def Checker_dbus_property(self, value=None):
1315
2173
        if value is None:       # get
1316
2174
            return dbus.String(self.checker_command)
1317
 
        self.checker_command = value
1318
 
    
 
2175
        self.checker_command = str(value)
 
2176
 
1319
2177
    # CheckerRunning - property
1320
 
    @dbus_service_property(_interface, signature="b",
 
2178
    @dbus_service_property(_interface,
 
2179
                           signature="b",
1321
2180
                           access="readwrite")
1322
2181
    def CheckerRunning_dbus_property(self, value=None):
1323
2182
        if value is None:       # get
1326
2185
            self.start_checker()
1327
2186
        else:
1328
2187
            self.stop_checker()
1329
 
    
 
2188
 
1330
2189
    # ObjectPath - property
 
2190
    @dbus_annotations(
 
2191
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2192
         "org.freedesktop.DBus.Deprecated": "true"})
1331
2193
    @dbus_service_property(_interface, signature="o", access="read")
1332
2194
    def ObjectPath_dbus_property(self):
1333
 
        return self.dbus_object_path # is already a dbus.ObjectPath
1334
 
    
 
2195
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
2196
 
1335
2197
    # Secret = property
1336
 
    @dbus_service_property(_interface, signature="ay",
1337
 
                           access="write", byte_arrays=True)
 
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)
1338
2205
    def Secret_dbus_property(self, value):
1339
 
        self.secret = str(value)
1340
 
    
 
2206
        self.secret = bytes(value)
 
2207
 
1341
2208
    del _interface
1342
2209
 
1343
2210
 
1344
2211
class ProxyClient(object):
1345
 
    def __init__(self, child_pipe, fpr, address):
 
2212
    def __init__(self, child_pipe, key_id, fpr, address):
1346
2213
        self._pipe = child_pipe
1347
 
        self._pipe.send(('init', fpr, address))
 
2214
        self._pipe.send(('init', key_id, fpr, address))
1348
2215
        if not self._pipe.recv():
1349
 
            raise KeyError()
1350
 
    
 
2216
            raise KeyError(key_id or fpr)
 
2217
 
1351
2218
    def __getattribute__(self, name):
1352
 
        if(name == '_pipe'):
 
2219
        if name == '_pipe':
1353
2220
            return super(ProxyClient, self).__getattribute__(name)
1354
2221
        self._pipe.send(('getattr', name))
1355
2222
        data = self._pipe.recv()
1356
2223
        if data[0] == 'data':
1357
2224
            return data[1]
1358
2225
        if data[0] == 'function':
 
2226
 
1359
2227
            def func(*args, **kwargs):
1360
2228
                self._pipe.send(('funcall', name, args, kwargs))
1361
2229
                return self._pipe.recv()[1]
 
2230
 
1362
2231
            return func
1363
 
    
 
2232
 
1364
2233
    def __setattr__(self, name, value):
1365
 
        if(name == '_pipe'):
 
2234
        if name == '_pipe':
1366
2235
            return super(ProxyClient, self).__setattr__(name, value)
1367
2236
        self._pipe.send(('setattr', name, value))
1368
2237
 
1369
 
class ClientDBusTransitional(ClientDBus):
1370
 
    __metaclass__ = AlternateDBusNamesMetaclass
1371
2238
 
1372
2239
class ClientHandler(socketserver.BaseRequestHandler, object):
1373
2240
    """A class to handle client connections.
1374
 
    
 
2241
 
1375
2242
    Instantiated once for each connection to handle it.
1376
2243
    Note: This will run in its own forked process."""
1377
 
    
 
2244
 
1378
2245
    def handle(self):
1379
2246
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1380
2247
            logger.info("TCP connection from: %s",
1381
 
                        unicode(self.client_address))
 
2248
                        str(self.client_address))
1382
2249
            logger.debug("Pipe FD: %d",
1383
2250
                         self.server.child_pipe.fileno())
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"))
 
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"))
1399
2258
            # Use a fallback default, since this MUST be set.
1400
2259
            priority = self.server.gnutls_priority
1401
2260
            if priority is None:
1402
2261
                priority = "NORMAL"
1403
 
            (gnutls.library.functions
1404
 
             .gnutls_priority_set_direct(session._c_object,
1405
 
                                         priority, None))
1406
 
            
 
2262
            gnutls.priority_set_direct(session._c_object,
 
2263
                                       priority.encode("utf-8"),
 
2264
                                       None)
 
2265
 
1407
2266
            # Start communication using the Mandos protocol
1408
2267
            # Get protocol number
1409
2268
            line = self.request.makefile().readline()
1410
2269
            logger.debug("Protocol version: %r", line)
1411
2270
            try:
1412
2271
                if int(line.strip().split()[0]) > 1:
1413
 
                    raise RuntimeError
 
2272
                    raise RuntimeError(line)
1414
2273
            except (ValueError, IndexError, RuntimeError) as error:
1415
2274
                logger.error("Unknown protocol version: %s", error)
1416
2275
                return
1417
 
            
 
2276
 
1418
2277
            # Start GnuTLS connection
1419
2278
            try:
1420
2279
                session.handshake()
1421
 
            except gnutls.errors.GNUTLSError as error:
 
2280
            except gnutls.Error as error:
1422
2281
                logger.warning("Handshake failed: %s", error)
1423
2282
                # Do not run session.bye() here: the session is not
1424
2283
                # established.  Just abandon the request.
1425
2284
                return
1426
2285
            logger.debug("Handshake succeeded")
1427
 
            
 
2286
 
1428
2287
            approval_required = False
1429
2288
            try:
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,
 
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,
1441
2311
                                         self.client_address)
1442
2312
                except KeyError:
1443
2313
                    return
1444
 
                
 
2314
 
1445
2315
                if client.approval_delay:
1446
2316
                    delay = client.approval_delay
1447
2317
                    client.approvals_pending += 1
1448
2318
                    approval_required = True
1449
 
                
 
2319
 
1450
2320
                while True:
1451
2321
                    if not client.enabled:
1452
2322
                        logger.info("Client %s is disabled",
1453
 
                                       client.name)
 
2323
                                    client.name)
1454
2324
                        if self.server.use_dbus:
1455
2325
                            # Emit D-Bus signal
1456
2326
                            client.Rejected("Disabled")
1457
2327
                        return
1458
 
                    
1459
 
                    if client._approved or not client.approval_delay:
1460
 
                        #We are approved or approval is disabled
 
2328
 
 
2329
                    if client.approved or not client.approval_delay:
 
2330
                        # We are approved or approval is disabled
1461
2331
                        break
1462
 
                    elif client._approved is None:
 
2332
                    elif client.approved is None:
1463
2333
                        logger.info("Client %s needs approval",
1464
2334
                                    client.name)
1465
2335
                        if self.server.use_dbus:
1466
2336
                            # Emit D-Bus signal
1467
2337
                            client.NeedApproval(
1468
 
                                client.approval_delay_milliseconds(),
1469
 
                                client.approved_by_default)
 
2338
                                client.approval_delay.total_seconds()
 
2339
                                * 1000, client.approved_by_default)
1470
2340
                    else:
1471
2341
                        logger.warning("Client %s was not approved",
1472
2342
                                       client.name)
1474
2344
                            # Emit D-Bus signal
1475
2345
                            client.Rejected("Denied")
1476
2346
                        return
1477
 
                    
1478
 
                    #wait until timeout or approved
 
2347
 
 
2348
                    # wait until timeout or approved
1479
2349
                    time = datetime.datetime.now()
1480
2350
                    client.changedstate.acquire()
1481
 
                    (client.changedstate.wait
1482
 
                     (float(client._timedelta_to_milliseconds(delay)
1483
 
                            / 1000)))
 
2351
                    client.changedstate.wait(delay.total_seconds())
1484
2352
                    client.changedstate.release()
1485
2353
                    time2 = datetime.datetime.now()
1486
2354
                    if (time2 - time) >= delay:
1496
2364
                            break
1497
2365
                    else:
1498
2366
                        delay -= time2 - time
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
 
                
 
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
 
1512
2375
                logger.info("Sending secret to %s", client.name)
1513
2376
                # bump the timeout using extended_timeout
1514
 
                client.checked_ok(client.extended_timeout)
 
2377
                client.bump_timeout(client.extended_timeout)
1515
2378
                if self.server.use_dbus:
1516
2379
                    # Emit D-Bus signal
1517
2380
                    client.GotSecret()
1518
 
            
 
2381
 
1519
2382
            finally:
1520
2383
                if approval_required:
1521
2384
                    client.approvals_pending -= 1
1522
2385
                try:
1523
2386
                    session.bye()
1524
 
                except gnutls.errors.GNUTLSError as error:
1525
 
                    logger.warning("GnuTLS bye failed")
1526
 
    
 
2387
                except gnutls.Error as error:
 
2388
                    logger.warning("GnuTLS bye failed",
 
2389
                                   exc_info=error)
 
2390
 
1527
2391
    @staticmethod
1528
2392
    def peer_certificate(session):
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
 
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""
1536
2409
        list_size = ctypes.c_uint(1)
1537
 
        cert_list = (gnutls.library.functions
1538
 
                     .gnutls_certificate_get_peers
 
2410
        cert_list = (gnutls.certificate_get_peers
1539
2411
                     (session._c_object, ctypes.byref(list_size)))
1540
2412
        if not bool(cert_list) and list_size.value != 0:
1541
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1542
 
                                            " certificate")
 
2413
            raise gnutls.Error("error getting peer certificate")
1543
2414
        if list_size.value == 0:
1544
2415
            return None
1545
2416
        cert = cert_list[0]
1546
2417
        return ctypes.string_at(cert.data, cert.size)
1547
 
    
 
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
 
1548
2453
    @staticmethod
1549
2454
    def fingerprint(openpgp):
1550
2455
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1551
2456
        # New GnuTLS "datum" with the OpenPGP public key
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))))
 
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)))
1557
2461
        # New empty GnuTLS certificate
1558
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1559
 
        (gnutls.library.functions
1560
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2462
        crt = gnutls.openpgp_crt_t()
 
2463
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1561
2464
        # Import the OpenPGP public key into the certificate
1562
 
        (gnutls.library.functions
1563
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1564
 
                                    gnutls.library.constants
1565
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2465
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2466
                                  gnutls.OPENPGP_FMT_RAW)
1566
2467
        # Verify the self signature in the key
1567
2468
        crtverify = ctypes.c_uint()
1568
 
        (gnutls.library.functions
1569
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1570
 
                                         ctypes.byref(crtverify)))
 
2469
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2470
                                       ctypes.byref(crtverify))
1571
2471
        if crtverify.value != 0:
1572
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1573
 
            raise (gnutls.errors.CertificateSecurityError
1574
 
                   ("Verify failed"))
 
2472
            gnutls.openpgp_crt_deinit(crt)
 
2473
            raise gnutls.CertificateSecurityError(code
 
2474
                                                  =crtverify.value)
1575
2475
        # New buffer for the fingerprint
1576
2476
        buf = ctypes.create_string_buffer(20)
1577
2477
        buf_len = ctypes.c_size_t()
1578
2478
        # Get the fingerprint from the certificate into the buffer
1579
 
        (gnutls.library.functions
1580
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1581
 
                                             ctypes.byref(buf_len)))
 
2479
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2480
                                           ctypes.byref(buf_len))
1582
2481
        # Deinit the certificate
1583
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2482
        gnutls.openpgp_crt_deinit(crt)
1584
2483
        # Convert the buffer to a Python bytestring
1585
2484
        fpr = ctypes.string_at(buf, buf_len.value)
1586
2485
        # Convert the bytestring to hexadecimal notation
1587
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
2486
        hex_fpr = binascii.hexlify(fpr).upper()
1588
2487
        return hex_fpr
1589
2488
 
1590
2489
 
1591
2490
class MultiprocessingMixIn(object):
1592
2491
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2492
 
1593
2493
    def sub_process_main(self, request, address):
1594
2494
        try:
1595
2495
            self.finish_request(request, address)
1596
 
        except:
 
2496
        except Exception:
1597
2497
            self.handle_error(request, address)
1598
2498
        self.close_request(request)
1599
 
    
 
2499
 
1600
2500
    def process_request(self, request, address):
1601
2501
        """Start a new process to process the request."""
1602
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1603
 
                                       args = (request,
1604
 
                                               address))
 
2502
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2503
                                       args=(request, address))
1605
2504
        proc.start()
1606
2505
        return proc
1607
2506
 
1608
2507
 
1609
2508
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1610
2509
    """ adds a pipe to the MixIn """
 
2510
 
1611
2511
    def process_request(self, request, client_address):
1612
2512
        """Overrides and wraps the original process_request().
1613
 
        
 
2513
 
1614
2514
        This function creates a new pipe in self.pipe
1615
2515
        """
1616
2516
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1617
 
        
 
2517
 
1618
2518
        proc = MultiprocessingMixIn.process_request(self, request,
1619
2519
                                                    client_address)
1620
2520
        self.child_pipe.close()
1621
2521
        self.add_pipe(parent_pipe, proc)
1622
 
    
 
2522
 
1623
2523
    def add_pipe(self, parent_pipe, proc):
1624
2524
        """Dummy function; override as necessary"""
1625
 
        raise NotImplementedError
 
2525
        raise NotImplementedError()
1626
2526
 
1627
2527
 
1628
2528
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1629
2529
                     socketserver.TCPServer, object):
1630
2530
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1631
 
    
 
2531
 
1632
2532
    Attributes:
1633
2533
        enabled:        Boolean; whether this server is activated yet
1634
2534
        interface:      None or a network interface name (string)
1635
2535
        use_ipv6:       Boolean; to use IPv6 or not
1636
2536
    """
 
2537
 
1637
2538
    def __init__(self, server_address, RequestHandlerClass,
1638
 
                 interface=None, use_ipv6=True):
 
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
        """
1639
2545
        self.interface = interface
1640
2546
        if use_ipv6:
1641
2547
            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.
1642
2575
        socketserver.TCPServer.__init__(self, server_address,
1643
2576
                                        RequestHandlerClass)
 
2577
 
1644
2578
    def server_bind(self):
1645
2579
        """This overrides the normal server_bind() function
1646
2580
        to bind to an interface if one was specified, and also NOT to
1647
2581
        bind to an address or port if they were not specified."""
 
2582
        global SO_BINDTODEVICE
1648
2583
        if self.interface is not None:
1649
2584
            if SO_BINDTODEVICE is None:
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
 
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
1670
2606
        # Only bind(2) the socket if we really need to.
1671
2607
        if self.server_address[0] or self.server_address[1]:
 
2608
            if self.server_address[1]:
 
2609
                self.allow_reuse_address = True
1672
2610
            if not self.server_address[0]:
1673
2611
                if self.address_family == socket.AF_INET6:
1674
 
                    any_address = "::" # in6addr_any
 
2612
                    any_address = "::"  # in6addr_any
1675
2613
                else:
1676
 
                    any_address = socket.INADDR_ANY
 
2614
                    any_address = "0.0.0.0"  # INADDR_ANY
1677
2615
                self.server_address = (any_address,
1678
2616
                                       self.server_address[1])
1679
2617
            elif not self.server_address[1]:
1680
 
                self.server_address = (self.server_address[0],
1681
 
                                       0)
 
2618
                self.server_address = (self.server_address[0], 0)
1682
2619
#                 if self.interface:
1683
2620
#                     self.server_address = (self.server_address[0],
1684
2621
#                                            0, # port
1690
2627
 
1691
2628
class MandosServer(IPv6_TCPServer):
1692
2629
    """Mandos server.
1693
 
    
 
2630
 
1694
2631
    Attributes:
1695
2632
        clients:        set of Client objects
1696
2633
        gnutls_priority GnuTLS priority string
1697
2634
        use_dbus:       Boolean; to emit D-Bus signals or not
1698
 
    
1699
 
    Assumes a gobject.MainLoop event loop.
 
2635
 
 
2636
    Assumes a GLib.MainLoop event loop.
1700
2637
    """
 
2638
 
1701
2639
    def __init__(self, server_address, RequestHandlerClass,
1702
 
                 interface=None, use_ipv6=True, clients=None,
1703
 
                 gnutls_priority=None, use_dbus=True):
 
2640
                 interface=None,
 
2641
                 use_ipv6=True,
 
2642
                 clients=None,
 
2643
                 gnutls_priority=None,
 
2644
                 use_dbus=True,
 
2645
                 socketfd=None):
1704
2646
        self.enabled = False
1705
2647
        self.clients = clients
1706
2648
        if self.clients is None:
1709
2651
        self.gnutls_priority = gnutls_priority
1710
2652
        IPv6_TCPServer.__init__(self, server_address,
1711
2653
                                RequestHandlerClass,
1712
 
                                interface = interface,
1713
 
                                use_ipv6 = use_ipv6)
 
2654
                                interface=interface,
 
2655
                                use_ipv6=use_ipv6,
 
2656
                                socketfd=socketfd)
 
2657
 
1714
2658
    def server_activate(self):
1715
2659
        if self.enabled:
1716
2660
            return socketserver.TCPServer.server_activate(self)
1717
 
    
 
2661
 
1718
2662
    def enable(self):
1719
2663
        self.enabled = True
1720
 
    
 
2664
 
1721
2665
    def add_pipe(self, parent_pipe, proc):
1722
2666
        # Call "handle_ipc" for both data and EOF events
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)
 
2667
        GLib.io_add_watch(
 
2668
            parent_pipe.fileno(),
 
2669
            GLib.IO_IN | GLib.IO_HUP,
 
2670
            functools.partial(self.handle_ipc,
 
2671
                              parent_pipe=parent_pipe,
 
2672
                              proc=proc))
 
2673
 
 
2674
    def handle_ipc(self, source, condition,
 
2675
                   parent_pipe=None,
 
2676
                   proc=None,
 
2677
                   client_object=None):
1746
2678
        # error, or the other end of multiprocessing.Pipe has closed
1747
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2679
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
1748
2680
            # Wait for other process to exit
1749
2681
            proc.join()
1750
2682
            return False
1751
 
        
 
2683
 
1752
2684
        # Read a request from the child
1753
2685
        request = parent_pipe.recv()
1754
2686
        command = request[0]
1755
 
        
 
2687
 
1756
2688
        if command == 'init':
1757
 
            fpr = request[1]
1758
 
            address = request[2]
1759
 
            
1760
 
            for c in self.clients.itervalues():
1761
 
                if c.fingerprint == fpr:
 
2689
            key_id = request[1].decode("ascii")
 
2690
            fpr = request[2].decode("ascii")
 
2691
            address = request[3]
 
2692
 
 
2693
            for c in self.clients.values():
 
2694
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
 
2695
                    continue
 
2696
                if key_id and c.key_id == key_id:
 
2697
                    client = c
 
2698
                    break
 
2699
                if fpr and c.fingerprint == fpr:
1762
2700
                    client = c
1763
2701
                    break
1764
2702
            else:
1765
 
                logger.info("Client not found for fingerprint: %s, ad"
1766
 
                            "dress: %s", fpr, address)
 
2703
                logger.info("Client not found for key ID: %s, address"
 
2704
                            ": %s", key_id or fpr, address)
1767
2705
                if self.use_dbus:
1768
2706
                    # Emit D-Bus signal
1769
 
                    mandos_dbus_service.ClientNotFound(fpr,
 
2707
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
1770
2708
                                                       address[0])
1771
2709
                parent_pipe.send(False)
1772
2710
                return False
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))
 
2711
 
 
2712
            GLib.io_add_watch(
 
2713
                parent_pipe.fileno(),
 
2714
                GLib.IO_IN | GLib.IO_HUP,
 
2715
                functools.partial(self.handle_ipc,
 
2716
                                  parent_pipe=parent_pipe,
 
2717
                                  proc=proc,
 
2718
                                  client_object=client))
1782
2719
            parent_pipe.send(True)
1783
2720
            # remove the old hook in favor of the new above hook on
1784
2721
            # same fileno
1787
2724
            funcname = request[1]
1788
2725
            args = request[2]
1789
2726
            kwargs = request[3]
1790
 
            
 
2727
 
1791
2728
            parent_pipe.send(('data', getattr(client_object,
1792
2729
                                              funcname)(*args,
1793
 
                                                         **kwargs)))
1794
 
        
 
2730
                                                        **kwargs)))
 
2731
 
1795
2732
        if command == 'getattr':
1796
2733
            attrname = request[1]
1797
 
            if callable(client_object.__getattribute__(attrname)):
1798
 
                parent_pipe.send(('function',))
 
2734
            if isinstance(client_object.__getattribute__(attrname),
 
2735
                          collections.Callable):
 
2736
                parent_pipe.send(('function', ))
1799
2737
            else:
1800
 
                parent_pipe.send(('data', client_object
1801
 
                                  .__getattribute__(attrname)))
1802
 
        
 
2738
                parent_pipe.send((
 
2739
                    'data', client_object.__getattribute__(attrname)))
 
2740
 
1803
2741
        if command == 'setattr':
1804
2742
            attrname = request[1]
1805
2743
            value = request[2]
1806
2744
            setattr(client_object, attrname, value)
1807
 
        
 
2745
 
1808
2746
        return True
1809
2747
 
1810
2748
 
 
2749
def rfc3339_duration_to_delta(duration):
 
2750
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2751
 
 
2752
    >>> rfc3339_duration_to_delta("P7D")
 
2753
    datetime.timedelta(7)
 
2754
    >>> rfc3339_duration_to_delta("PT60S")
 
2755
    datetime.timedelta(0, 60)
 
2756
    >>> rfc3339_duration_to_delta("PT60M")
 
2757
    datetime.timedelta(0, 3600)
 
2758
    >>> rfc3339_duration_to_delta("PT24H")
 
2759
    datetime.timedelta(1)
 
2760
    >>> rfc3339_duration_to_delta("P1W")
 
2761
    datetime.timedelta(7)
 
2762
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2763
    datetime.timedelta(0, 330)
 
2764
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2765
    datetime.timedelta(1, 200)
 
2766
    """
 
2767
 
 
2768
    # Parsing an RFC 3339 duration with regular expressions is not
 
2769
    # possible - there would have to be multiple places for the same
 
2770
    # values, like seconds.  The current code, while more esoteric, is
 
2771
    # cleaner without depending on a parsing library.  If Python had a
 
2772
    # built-in library for parsing we would use it, but we'd like to
 
2773
    # avoid excessive use of external libraries.
 
2774
 
 
2775
    # New type for defining tokens, syntax, and semantics all-in-one
 
2776
    Token = collections.namedtuple("Token", (
 
2777
        "regexp",  # To match token; if "value" is not None, must have
 
2778
                   # a "group" containing digits
 
2779
        "value",   # datetime.timedelta or None
 
2780
        "followers"))           # Tokens valid after this token
 
2781
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2782
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2783
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2784
    token_second = Token(re.compile(r"(\d+)S"),
 
2785
                         datetime.timedelta(seconds=1),
 
2786
                         frozenset((token_end, )))
 
2787
    token_minute = Token(re.compile(r"(\d+)M"),
 
2788
                         datetime.timedelta(minutes=1),
 
2789
                         frozenset((token_second, token_end)))
 
2790
    token_hour = Token(re.compile(r"(\d+)H"),
 
2791
                       datetime.timedelta(hours=1),
 
2792
                       frozenset((token_minute, token_end)))
 
2793
    token_time = Token(re.compile(r"T"),
 
2794
                       None,
 
2795
                       frozenset((token_hour, token_minute,
 
2796
                                  token_second)))
 
2797
    token_day = Token(re.compile(r"(\d+)D"),
 
2798
                      datetime.timedelta(days=1),
 
2799
                      frozenset((token_time, token_end)))
 
2800
    token_month = Token(re.compile(r"(\d+)M"),
 
2801
                        datetime.timedelta(weeks=4),
 
2802
                        frozenset((token_day, token_end)))
 
2803
    token_year = Token(re.compile(r"(\d+)Y"),
 
2804
                       datetime.timedelta(weeks=52),
 
2805
                       frozenset((token_month, token_end)))
 
2806
    token_week = Token(re.compile(r"(\d+)W"),
 
2807
                       datetime.timedelta(weeks=1),
 
2808
                       frozenset((token_end, )))
 
2809
    token_duration = Token(re.compile(r"P"), None,
 
2810
                           frozenset((token_year, token_month,
 
2811
                                      token_day, token_time,
 
2812
                                      token_week)))
 
2813
    # Define starting values:
 
2814
    # Value so far
 
2815
    value = datetime.timedelta()
 
2816
    found_token = None
 
2817
    # Following valid tokens
 
2818
    followers = frozenset((token_duration, ))
 
2819
    # String left to parse
 
2820
    s = duration
 
2821
    # Loop until end token is found
 
2822
    while found_token is not token_end:
 
2823
        # Search for any currently valid tokens
 
2824
        for token in followers:
 
2825
            match = token.regexp.match(s)
 
2826
            if match is not None:
 
2827
                # Token found
 
2828
                if token.value is not None:
 
2829
                    # Value found, parse digits
 
2830
                    factor = int(match.group(1), 10)
 
2831
                    # Add to value so far
 
2832
                    value += factor * token.value
 
2833
                # Strip token from string
 
2834
                s = token.regexp.sub("", s, 1)
 
2835
                # Go to found token
 
2836
                found_token = token
 
2837
                # Set valid next tokens
 
2838
                followers = found_token.followers
 
2839
                break
 
2840
        else:
 
2841
            # No currently valid tokens were found
 
2842
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2843
                             .format(duration))
 
2844
    # End token found
 
2845
    return value
 
2846
 
 
2847
 
1811
2848
def string_to_delta(interval):
1812
2849
    """Parse a string and return a datetime.timedelta
1813
 
    
 
2850
 
1814
2851
    >>> string_to_delta('7d')
1815
2852
    datetime.timedelta(7)
1816
2853
    >>> string_to_delta('60s')
1824
2861
    >>> string_to_delta('5m 30s')
1825
2862
    datetime.timedelta(0, 330)
1826
2863
    """
 
2864
 
 
2865
    try:
 
2866
        return rfc3339_duration_to_delta(interval)
 
2867
    except ValueError:
 
2868
        pass
 
2869
 
1827
2870
    timevalue = datetime.timedelta(0)
1828
2871
    for s in interval.split():
1829
2872
        try:
1830
 
            suffix = unicode(s[-1])
 
2873
            suffix = s[-1]
1831
2874
            value = int(s[:-1])
1832
2875
            if suffix == "d":
1833
2876
                delta = datetime.timedelta(value)
1840
2883
            elif suffix == "w":
1841
2884
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1842
2885
            else:
1843
 
                raise ValueError("Unknown suffix %r" % suffix)
1844
 
        except (ValueError, IndexError) as e:
 
2886
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2887
        except IndexError as e:
1845
2888
            raise ValueError(*(e.args))
1846
2889
        timevalue += delta
1847
2890
    return timevalue
1848
2891
 
1849
2892
 
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):
 
2893
def daemon(nochdir=False, noclose=False):
1875
2894
    """See daemon(3).  Standard BSD Unix function.
1876
 
    
 
2895
 
1877
2896
    This should really exist as os.daemon, but it doesn't (yet)."""
1878
2897
    if os.fork():
1879
2898
        sys.exit()
1884
2903
        sys.exit()
1885
2904
    if not noclose:
1886
2905
        # Close all standard open file descriptors
1887
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2906
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1888
2907
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1889
2908
            raise OSError(errno.ENODEV,
1890
 
                          "%s not a character device"
1891
 
                          % os.path.devnull)
 
2909
                          "{} not a character device"
 
2910
                          .format(os.devnull))
1892
2911
        os.dup2(null, sys.stdin.fileno())
1893
2912
        os.dup2(null, sys.stdout.fileno())
1894
2913
        os.dup2(null, sys.stderr.fileno())
1897
2916
 
1898
2917
 
1899
2918
def main():
1900
 
    
 
2919
 
1901
2920
    ##################################################################
1902
2921
    # Parsing of options, both command line and config file
1903
 
    
 
2922
 
1904
2923
    parser = argparse.ArgumentParser()
1905
2924
    parser.add_argument("-v", "--version", action="version",
1906
 
                        version = "%%(prog)s %s" % version,
 
2925
                        version="%(prog)s {}".format(version),
1907
2926
                        help="show version number and exit")
1908
2927
    parser.add_argument("-i", "--interface", metavar="IF",
1909
2928
                        help="Bind to interface IF")
1915
2934
                        help="Run self-test")
1916
2935
    parser.add_argument("--debug", action="store_true",
1917
2936
                        help="Debug mode; run in foreground and log"
1918
 
                        " to terminal")
 
2937
                        " to terminal", default=None)
1919
2938
    parser.add_argument("--debuglevel", metavar="LEVEL",
1920
2939
                        help="Debug level for stdout output")
1921
2940
    parser.add_argument("--priority", help="GnuTLS"
1928
2947
                        " files")
1929
2948
    parser.add_argument("--no-dbus", action="store_false",
1930
2949
                        dest="use_dbus", help="Do not provide D-Bus"
1931
 
                        " system bus interface")
 
2950
                        " system bus interface", default=None)
1932
2951
    parser.add_argument("--no-ipv6", action="store_false",
1933
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2952
                        dest="use_ipv6", help="Do not use IPv6",
 
2953
                        default=None)
1934
2954
    parser.add_argument("--no-restore", action="store_false",
1935
 
                        dest="restore",
1936
 
                        help="Do not restore stored state",
1937
 
                        default=True)
 
2955
                        dest="restore", help="Do not restore stored"
 
2956
                        " state", default=None)
 
2957
    parser.add_argument("--socket", type=int,
 
2958
                        help="Specify a file descriptor to a network"
 
2959
                        " socket to use instead of creating one")
 
2960
    parser.add_argument("--statedir", metavar="DIR",
 
2961
                        help="Directory to save/restore state in")
 
2962
    parser.add_argument("--foreground", action="store_true",
 
2963
                        help="Run in foreground", default=None)
 
2964
    parser.add_argument("--no-zeroconf", action="store_false",
 
2965
                        dest="zeroconf", help="Do not use Zeroconf",
 
2966
                        default=None)
1938
2967
 
1939
2968
    options = parser.parse_args()
1940
 
    
 
2969
 
1941
2970
    if options.check:
1942
2971
        import doctest
1943
 
        doctest.testmod()
1944
 
        sys.exit()
1945
 
    
 
2972
        fail_count, test_count = doctest.testmod()
 
2973
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2974
 
1946
2975
    # Default values for config file for server-global settings
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
 
    
 
2976
    if gnutls.has_rawpk:
 
2977
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
 
2978
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
 
2979
    else:
 
2980
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2981
                    ":+SIGN-DSA-SHA256")
 
2982
    server_defaults = {"interface": "",
 
2983
                       "address": "",
 
2984
                       "port": "",
 
2985
                       "debug": "False",
 
2986
                       "priority": priority,
 
2987
                       "servicename": "Mandos",
 
2988
                       "use_dbus": "True",
 
2989
                       "use_ipv6": "True",
 
2990
                       "debuglevel": "",
 
2991
                       "restore": "True",
 
2992
                       "socket": "",
 
2993
                       "statedir": "/var/lib/mandos",
 
2994
                       "foreground": "False",
 
2995
                       "zeroconf": "True",
 
2996
                       }
 
2997
    del priority
 
2998
 
1959
2999
    # Parse config file for server-global settings
1960
3000
    server_config = configparser.SafeConfigParser(server_defaults)
1961
3001
    del server_defaults
1962
 
    server_config.read(os.path.join(options.configdir,
1963
 
                                    "mandos.conf"))
 
3002
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
1964
3003
    # Convert the SafeConfigParser object to a dict
1965
3004
    server_settings = server_config.defaults()
1966
3005
    # Use the appropriate methods on the non-string config options
1967
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
3006
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
3007
                   "foreground", "zeroconf"):
1968
3008
        server_settings[option] = server_config.getboolean("DEFAULT",
1969
3009
                                                           option)
1970
3010
    if server_settings["port"]:
1971
3011
        server_settings["port"] = server_config.getint("DEFAULT",
1972
3012
                                                       "port")
 
3013
    if server_settings["socket"]:
 
3014
        server_settings["socket"] = server_config.getint("DEFAULT",
 
3015
                                                         "socket")
 
3016
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
3017
        # over with an opened os.devnull.  But we don't want this to
 
3018
        # happen with a supplied network socket.
 
3019
        if 0 <= server_settings["socket"] <= 2:
 
3020
            server_settings["socket"] = os.dup(server_settings
 
3021
                                               ["socket"])
1973
3022
    del server_config
1974
 
    
 
3023
 
1975
3024
    # Override the settings from the config file with command line
1976
3025
    # options, if set.
1977
3026
    for option in ("interface", "address", "port", "debug",
1978
 
                   "priority", "servicename", "configdir",
1979
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore"):
 
3027
                   "priority", "servicename", "configdir", "use_dbus",
 
3028
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
3029
                   "socket", "foreground", "zeroconf"):
1980
3030
        value = getattr(options, option)
1981
3031
        if value is not None:
1982
3032
            server_settings[option] = value
1983
3033
    del options
1984
3034
    # Force all strings to be unicode
1985
3035
    for option in server_settings.keys():
1986
 
        if type(server_settings[option]) is str:
1987
 
            server_settings[option] = unicode(server_settings[option])
 
3036
        if isinstance(server_settings[option], bytes):
 
3037
            server_settings[option] = (server_settings[option]
 
3038
                                       .decode("utf-8"))
 
3039
    # Force all boolean options to be boolean
 
3040
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
3041
                   "foreground", "zeroconf"):
 
3042
        server_settings[option] = bool(server_settings[option])
 
3043
    # Debug implies foreground
 
3044
    if server_settings["debug"]:
 
3045
        server_settings["foreground"] = True
1988
3046
    # Now we have our good server settings in "server_settings"
1989
 
    
 
3047
 
1990
3048
    ##################################################################
1991
 
    
 
3049
 
 
3050
    if (not server_settings["zeroconf"]
 
3051
        and not (server_settings["port"]
 
3052
                 or server_settings["socket"] != "")):
 
3053
        parser.error("Needs port or socket to work without Zeroconf")
 
3054
 
1992
3055
    # For convenience
1993
3056
    debug = server_settings["debug"]
1994
3057
    debuglevel = server_settings["debuglevel"]
1995
3058
    use_dbus = server_settings["use_dbus"]
1996
3059
    use_ipv6 = server_settings["use_ipv6"]
1997
 
    
 
3060
    stored_state_path = os.path.join(server_settings["statedir"],
 
3061
                                     stored_state_file)
 
3062
    foreground = server_settings["foreground"]
 
3063
    zeroconf = server_settings["zeroconf"]
 
3064
 
 
3065
    if debug:
 
3066
        initlogger(debug, logging.DEBUG)
 
3067
    else:
 
3068
        if not debuglevel:
 
3069
            initlogger(debug)
 
3070
        else:
 
3071
            level = getattr(logging, debuglevel.upper())
 
3072
            initlogger(debug, level)
 
3073
 
1998
3074
    if server_settings["servicename"] != "Mandos":
1999
 
        syslogger.setFormatter(logging.Formatter
2000
 
                               ('Mandos (%s) [%%(process)d]:'
2001
 
                                ' %%(levelname)s: %%(message)s'
2002
 
                                % server_settings["servicename"]))
2003
 
    
 
3075
        syslogger.setFormatter(
 
3076
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3077
                              ' %(levelname)s: %(message)s'.format(
 
3078
                                  server_settings["servicename"])))
 
3079
 
2004
3080
    # Parse config file with clients
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
    client_config = configparser.SafeConfigParser(Client
 
3082
                                                  .client_defaults)
2014
3083
    client_config.read(os.path.join(server_settings["configdir"],
2015
3084
                                    "clients.conf"))
2016
 
    
 
3085
 
2017
3086
    global mandos_dbus_service
2018
3087
    mandos_dbus_service = None
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
 
3088
 
 
3089
    socketfd = None
 
3090
    if server_settings["socket"] != "":
 
3091
        socketfd = server_settings["socket"]
 
3092
    tcp_server = MandosServer(
 
3093
        (server_settings["address"], server_settings["port"]),
 
3094
        ClientHandler,
 
3095
        interface=(server_settings["interface"] or None),
 
3096
        use_ipv6=use_ipv6,
 
3097
        gnutls_priority=server_settings["priority"],
 
3098
        use_dbus=use_dbus,
 
3099
        socketfd=socketfd)
 
3100
    if not foreground:
 
3101
        pidfilename = "/run/mandos.pid"
 
3102
        if not os.path.isdir("/run/."):
 
3103
            pidfilename = "/var/run/mandos.pid"
 
3104
        pidfile = None
 
3105
        try:
 
3106
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
3107
        except IOError as e:
 
3108
            logger.error("Could not open file %r", pidfilename,
 
3109
                         exc_info=e)
 
3110
 
 
3111
    for name, group in (("_mandos", "_mandos"),
 
3112
                        ("mandos", "mandos"),
 
3113
                        ("nobody", "nogroup")):
 
3114
        try:
 
3115
            uid = pwd.getpwnam(name).pw_uid
 
3116
            gid = pwd.getpwnam(group).pw_gid
 
3117
            break
2043
3118
        except KeyError:
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
 
3119
            continue
 
3120
    else:
 
3121
        uid = 65534
 
3122
        gid = 65534
2050
3123
    try:
2051
3124
        os.setgid(gid)
2052
3125
        os.setuid(uid)
 
3126
        if debug:
 
3127
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3128
                                                             gid))
2053
3129
    except OSError as error:
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
 
    
 
3130
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3131
                       .format(uid, gid, os.strerror(error.errno)))
 
3132
        if error.errno != errno.EPERM:
 
3133
            raise
 
3134
 
2063
3135
    if debug:
2064
 
        logger.setLevel(logging.DEBUG)
2065
3136
        # Enable all possible GnuTLS debugging
2066
 
        
 
3137
 
2067
3138
        # "Use a log level over 10 to enable all debugging options."
2068
3139
        # - GnuTLS manual
2069
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
2070
 
        
2071
 
        @gnutls.library.types.gnutls_log_func
 
3140
        gnutls.global_set_log_level(11)
 
3141
 
 
3142
        @gnutls.log_func
2072
3143
        def debug_gnutls(level, string):
2073
3144
            logger.debug("GnuTLS: %s", string[:-1])
2074
 
        
2075
 
        (gnutls.library.functions
2076
 
         .gnutls_global_set_log_function(debug_gnutls))
2077
 
        
 
3145
 
 
3146
        gnutls.global_set_log_function(debug_gnutls)
 
3147
 
2078
3148
        # Redirect stdin so all checkers get /dev/null
2079
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
3149
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2080
3150
        os.dup2(null, sys.stdin.fileno())
2081
3151
        if null > 2:
2082
3152
            os.close(null)
2083
 
    else:
2084
 
        # No console logging
2085
 
        logger.removeHandler(console)
2086
 
    
 
3153
 
2087
3154
    # Need to fork before connecting to D-Bus
2088
 
    if not debug:
 
3155
    if not foreground:
2089
3156
        # Close all input and output, do double fork, etc.
2090
3157
        daemon()
2091
 
    
 
3158
 
 
3159
    # multiprocessing will use threads, so before we use GLib we need
 
3160
    # to inform GLib that threads will be used.
 
3161
    GLib.threads_init()
 
3162
 
2092
3163
    global main_loop
2093
3164
    # From the Avahi example code
2094
 
    DBusGMainLoop(set_as_default=True )
2095
 
    main_loop = gobject.MainLoop()
 
3165
    DBusGMainLoop(set_as_default=True)
 
3166
    main_loop = GLib.MainLoop()
2096
3167
    bus = dbus.SystemBus()
2097
3168
    # End of Avahi example code
2098
3169
    if use_dbus:
2099
3170
        try:
2100
3171
            bus_name = dbus.service.BusName("se.recompile.Mandos",
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")
 
3172
                                            bus,
 
3173
                                            do_not_queue=True)
 
3174
            old_bus_name = dbus.service.BusName(
 
3175
                "se.bsnet.fukt.Mandos", bus,
 
3176
                do_not_queue=True)
 
3177
        except dbus.exceptions.DBusException as e:
 
3178
            logger.error("Disabling D-Bus:", exc_info=e)
2107
3179
            use_dbus = False
2108
3180
            server_settings["use_dbus"] = False
2109
3181
            tcp_server.use_dbus = False
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
 
    
 
3182
    if zeroconf:
 
3183
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
3184
        service = AvahiServiceToSyslog(
 
3185
            name=server_settings["servicename"],
 
3186
            servicetype="_mandos._tcp",
 
3187
            protocol=protocol,
 
3188
            bus=bus)
 
3189
        if server_settings["interface"]:
 
3190
            service.interface = if_nametoindex(
 
3191
                server_settings["interface"].encode("utf-8"))
 
3192
 
2119
3193
    global multiprocessing_manager
2120
3194
    multiprocessing_manager = multiprocessing.Manager()
2121
 
    
 
3195
 
2122
3196
    client_class = Client
2123
3197
    if use_dbus:
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
 
    
 
3198
        client_class = functools.partial(ClientDBus, bus=bus)
 
3199
 
 
3200
    client_settings = Client.config_parser(client_config)
2147
3201
    old_client_settings = {}
2148
 
    clients_data = []
2149
 
 
2150
 
    # Get client data and settings from last running state. 
 
3202
    clients_data = {}
 
3203
 
 
3204
    # This is used to redirect stdout and stderr for checker processes
 
3205
    global wnull
 
3206
    wnull = open(os.devnull, "w")  # A writable /dev/null
 
3207
    # Only used if server is running in foreground but not in debug
 
3208
    # mode
 
3209
    if debug or not foreground:
 
3210
        wnull.close()
 
3211
 
 
3212
    # Get client data and settings from last running state.
2151
3213
    if server_settings["restore"]:
2152
3214
        try:
2153
3215
            with open(stored_state_path, "rb") as stored_state:
2154
 
                clients_data, old_client_settings = (
2155
 
                    pickle.load(stored_state))
 
3216
                if sys.version_info.major == 2:
 
3217
                    clients_data, old_client_settings = pickle.load(
 
3218
                        stored_state)
 
3219
                else:
 
3220
                    bytes_clients_data, bytes_old_client_settings = (
 
3221
                        pickle.load(stored_state, encoding="bytes"))
 
3222
                    #   Fix bytes to strings
 
3223
                    #  clients_data
 
3224
                    # .keys()
 
3225
                    clients_data = {(key.decode("utf-8")
 
3226
                                     if isinstance(key, bytes)
 
3227
                                     else key): value
 
3228
                                    for key, value in
 
3229
                                    bytes_clients_data.items()}
 
3230
                    del bytes_clients_data
 
3231
                    for key in clients_data:
 
3232
                        value = {(k.decode("utf-8")
 
3233
                                  if isinstance(k, bytes) else k): v
 
3234
                                 for k, v in
 
3235
                                 clients_data[key].items()}
 
3236
                        clients_data[key] = value
 
3237
                        # .client_structure
 
3238
                        value["client_structure"] = [
 
3239
                            (s.decode("utf-8")
 
3240
                             if isinstance(s, bytes)
 
3241
                             else s) for s in
 
3242
                            value["client_structure"]]
 
3243
                        # .name & .host
 
3244
                        for k in ("name", "host"):
 
3245
                            if isinstance(value[k], bytes):
 
3246
                                value[k] = value[k].decode("utf-8")
 
3247
                        if not value.has_key("key_id"):
 
3248
                            value["key_id"] = ""
 
3249
                        elif not value.has_key("fingerprint"):
 
3250
                            value["fingerprint"] = ""
 
3251
                    #  old_client_settings
 
3252
                    # .keys()
 
3253
                    old_client_settings = {
 
3254
                        (key.decode("utf-8")
 
3255
                         if isinstance(key, bytes)
 
3256
                         else key): value
 
3257
                        for key, value in
 
3258
                        bytes_old_client_settings.items()}
 
3259
                    del bytes_old_client_settings
 
3260
                    # .host
 
3261
                    for value in old_client_settings.values():
 
3262
                        if isinstance(value["host"], bytes):
 
3263
                            value["host"] = (value["host"]
 
3264
                                             .decode("utf-8"))
2156
3265
            os.remove(stored_state_path)
2157
3266
        except IOError as e:
2158
 
            logger.warning("Could not load persistant state: {0}"
2159
 
                           .format(e))
2160
 
            if e.errno != errno.ENOENT:
 
3267
            if e.errno == errno.ENOENT:
 
3268
                logger.warning("Could not load persistent state:"
 
3269
                               " {}".format(os.strerror(e.errno)))
 
3270
            else:
 
3271
                logger.critical("Could not load persistent state:",
 
3272
                                exc_info=e)
2161
3273
                raise
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():
 
3274
        except EOFError as e:
 
3275
            logger.warning("Could not load persistent state: "
 
3276
                           "EOFError:",
 
3277
                           exc_info=e)
 
3278
 
 
3279
    with PGPEngine() as pgp:
 
3280
        for client_name, client in clients_data.items():
 
3281
            # Skip removed clients
 
3282
            if client_name not in client_settings:
 
3283
                continue
 
3284
 
 
3285
            # Decide which value to use after restoring saved state.
 
3286
            # We have three different values: Old config file,
 
3287
            # new config file, and saved state.
 
3288
            # New config value takes precedence if it differs from old
 
3289
            # config value, otherwise use saved state.
 
3290
            for name, value in client_settings[client_name].items():
 
3291
                try:
 
3292
                    # For each value in new config, check if it
 
3293
                    # differs from the old config value (Except for
 
3294
                    # the "secret" attribute)
 
3295
                    if (name != "secret"
 
3296
                        and (value !=
 
3297
                             old_client_settings[client_name][name])):
 
3298
                        client[name] = value
 
3299
                except KeyError:
 
3300
                    pass
 
3301
 
 
3302
            # Clients who has passed its expire date can still be
 
3303
            # enabled if its last checker was successful.  A Client
 
3304
            # whose checker succeeded before we stored its state is
 
3305
            # assumed to have successfully run all checkers during
 
3306
            # downtime.
 
3307
            if client["enabled"]:
 
3308
                if datetime.datetime.utcnow() >= client["expires"]:
 
3309
                    if not client["last_checked_ok"]:
 
3310
                        logger.warning(
 
3311
                            "disabling client {} - Client never "
 
3312
                            "performed a successful checker".format(
 
3313
                                client_name))
 
3314
                        client["enabled"] = False
 
3315
                    elif client["last_checker_status"] != 0:
 
3316
                        logger.warning(
 
3317
                            "disabling client {} - Client last"
 
3318
                            " checker failed with error code"
 
3319
                            " {}".format(
 
3320
                                client_name,
 
3321
                                client["last_checker_status"]))
 
3322
                        client["enabled"] = False
 
3323
                    else:
 
3324
                        client["expires"] = (
 
3325
                            datetime.datetime.utcnow()
 
3326
                            + client["timeout"])
 
3327
                        logger.debug("Last checker succeeded,"
 
3328
                                     " keeping {} enabled".format(
 
3329
                                         client_name))
2172
3330
            try:
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
 
    
 
3331
                client["secret"] = pgp.decrypt(
 
3332
                    client["encrypted_secret"],
 
3333
                    client_settings[client_name]["secret"])
 
3334
            except PGPError:
 
3335
                # If decryption fails, we use secret from new settings
 
3336
                logger.debug("Failed to decrypt {} old secret".format(
 
3337
                    client_name))
 
3338
                client["secret"] = (client_settings[client_name]
 
3339
                                    ["secret"])
 
3340
 
 
3341
    # Add/remove clients based on new changes made to config
 
3342
    for client_name in (set(old_client_settings)
 
3343
                        - set(client_settings)):
 
3344
        del clients_data[client_name]
 
3345
    for client_name in (set(client_settings)
 
3346
                        - set(old_client_settings)):
 
3347
        clients_data[client_name] = client_settings[client_name]
 
3348
 
 
3349
    # Create all client objects
 
3350
    for client_name, client in clients_data.items():
 
3351
        tcp_server.clients[client_name] = client_class(
 
3352
            name=client_name,
 
3353
            settings=client,
 
3354
            server_settings=server_settings)
 
3355
 
2225
3356
    if not tcp_server.clients:
2226
3357
        logger.warning("No clients defined")
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
 
3358
 
 
3359
    if not foreground:
 
3360
        if pidfile is not None:
 
3361
            pid = os.getpid()
 
3362
            try:
 
3363
                with pidfile:
 
3364
                    print(pid, file=pidfile)
 
3365
            except IOError:
 
3366
                logger.error("Could not write to file %r with PID %d",
 
3367
                             pidfilename, pid)
 
3368
        del pidfile
2240
3369
        del pidfilename
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
 
    
 
3370
 
 
3371
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3372
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3373
                             lambda: main_loop.quit() and False)
 
3374
 
2247
3375
    if use_dbus:
2248
 
        class MandosDBusService(dbus.service.Object):
 
3376
 
 
3377
        @alternate_dbus_interfaces(
 
3378
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3379
        class MandosDBusService(DBusObjectWithObjectManager):
2249
3380
            """A D-Bus proxy object"""
 
3381
 
2250
3382
            def __init__(self):
2251
3383
                dbus.service.Object.__init__(self, bus, "/")
 
3384
 
2252
3385
            _interface = "se.recompile.Mandos"
2253
 
            
 
3386
 
2254
3387
            @dbus.service.signal(_interface, signature="o")
2255
3388
            def ClientAdded(self, objpath):
2256
3389
                "D-Bus signal"
2257
3390
                pass
2258
 
            
 
3391
 
2259
3392
            @dbus.service.signal(_interface, signature="ss")
2260
 
            def ClientNotFound(self, fingerprint, address):
 
3393
            def ClientNotFound(self, key_id, address):
2261
3394
                "D-Bus signal"
2262
3395
                pass
2263
 
            
 
3396
 
 
3397
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3398
                               "true"})
2264
3399
            @dbus.service.signal(_interface, signature="os")
2265
3400
            def ClientRemoved(self, objpath, name):
2266
3401
                "D-Bus signal"
2267
3402
                pass
2268
 
            
 
3403
 
 
3404
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3405
                               "true"})
2269
3406
            @dbus.service.method(_interface, out_signature="ao")
2270
3407
            def GetAllClients(self):
2271
3408
                "D-Bus method"
2272
 
                return dbus.Array(c.dbus_object_path
2273
 
                                  for c in
2274
 
                                  tcp_server.clients.itervalues())
2275
 
            
 
3409
                return dbus.Array(c.dbus_object_path for c in
 
3410
                                  tcp_server.clients.values())
 
3411
 
 
3412
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3413
                               "true"})
2276
3414
            @dbus.service.method(_interface,
2277
3415
                                 out_signature="a{oa{sv}}")
2278
3416
            def GetAllClientsWithProperties(self):
2279
3417
                "D-Bus method"
2280
3418
                return dbus.Dictionary(
2281
 
                    ((c.dbus_object_path, c.GetAll(""))
2282
 
                     for c in tcp_server.clients.itervalues()),
 
3419
                    {c.dbus_object_path: c.GetAll(
 
3420
                        "se.recompile.Mandos.Client")
 
3421
                     for c in tcp_server.clients.values()},
2283
3422
                    signature="oa{sv}")
2284
 
            
 
3423
 
2285
3424
            @dbus.service.method(_interface, in_signature="o")
2286
3425
            def RemoveClient(self, object_path):
2287
3426
                "D-Bus method"
2288
 
                for c in tcp_server.clients.itervalues():
 
3427
                for c in tcp_server.clients.values():
2289
3428
                    if c.dbus_object_path == object_path:
2290
3429
                        del tcp_server.clients[c.name]
2291
3430
                        c.remove_from_connection()
2292
 
                        # Don't signal anything except ClientRemoved
 
3431
                        # Don't signal the disabling
2293
3432
                        c.disable(quiet=True)
2294
 
                        # Emit D-Bus signal
2295
 
                        self.ClientRemoved(object_path, c.name)
 
3433
                        # Emit D-Bus signal for removal
 
3434
                        self.client_removed_signal(c)
2296
3435
                        return
2297
3436
                raise KeyError(object_path)
2298
 
            
 
3437
 
2299
3438
            del _interface
2300
 
        
2301
 
        class MandosDBusServiceTransitional(MandosDBusService):
2302
 
            __metaclass__ = AlternateDBusNamesMetaclass
2303
 
        mandos_dbus_service = MandosDBusServiceTransitional()
2304
 
    
 
3439
 
 
3440
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3441
                                 out_signature="a{oa{sa{sv}}}")
 
3442
            def GetManagedObjects(self):
 
3443
                """D-Bus method"""
 
3444
                return dbus.Dictionary(
 
3445
                    {client.dbus_object_path:
 
3446
                     dbus.Dictionary(
 
3447
                         {interface: client.GetAll(interface)
 
3448
                          for interface in
 
3449
                          client._get_all_interface_names()})
 
3450
                     for client in tcp_server.clients.values()})
 
3451
 
 
3452
            def client_added_signal(self, client):
 
3453
                """Send the new standard signal and the old signal"""
 
3454
                if use_dbus:
 
3455
                    # New standard signal
 
3456
                    self.InterfacesAdded(
 
3457
                        client.dbus_object_path,
 
3458
                        dbus.Dictionary(
 
3459
                            {interface: client.GetAll(interface)
 
3460
                             for interface in
 
3461
                             client._get_all_interface_names()}))
 
3462
                    # Old signal
 
3463
                    self.ClientAdded(client.dbus_object_path)
 
3464
 
 
3465
            def client_removed_signal(self, client):
 
3466
                """Send the new standard signal and the old signal"""
 
3467
                if use_dbus:
 
3468
                    # New standard signal
 
3469
                    self.InterfacesRemoved(
 
3470
                        client.dbus_object_path,
 
3471
                        client._get_all_interface_names())
 
3472
                    # Old signal
 
3473
                    self.ClientRemoved(client.dbus_object_path,
 
3474
                                       client.name)
 
3475
 
 
3476
        mandos_dbus_service = MandosDBusService()
 
3477
 
 
3478
    # Save modules to variables to exempt the modules from being
 
3479
    # unloaded before the function registered with atexit() is run.
 
3480
    mp = multiprocessing
 
3481
    wn = wnull
 
3482
 
2305
3483
    def cleanup():
2306
3484
        "Cleanup function; run on exit"
2307
 
        service.cleanup()
2308
 
        
2309
 
        multiprocessing.active_children()
 
3485
        if zeroconf:
 
3486
            service.cleanup()
 
3487
 
 
3488
        mp.active_children()
 
3489
        wn.close()
2310
3490
        if not (tcp_server.clients or client_settings):
2311
3491
            return
2312
3492
 
2313
3493
        # Store client before exiting. Secrets are encrypted with key
2314
3494
        # based on what config file has. If config file is
2315
3495
        # removed/edited, old secret will thus be unrecovable.
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
 
            
 
3496
        clients = {}
 
3497
        with PGPEngine() as pgp:
 
3498
            for client in tcp_server.clients.values():
 
3499
                key = client_settings[client.name]["secret"]
 
3500
                client.encrypted_secret = pgp.encrypt(client.secret,
 
3501
                                                      key)
 
3502
                client_dict = {}
 
3503
 
 
3504
                # A list of attributes that can not be pickled
 
3505
                # + secret.
 
3506
                exclude = {"bus", "changedstate", "secret",
 
3507
                           "checker", "server_settings"}
 
3508
                for name, typ in inspect.getmembers(dbus.service
 
3509
                                                    .Object):
 
3510
                    exclude.add(name)
 
3511
 
 
3512
                client_dict["encrypted_secret"] = (client
 
3513
                                                   .encrypted_secret)
 
3514
                for attr in client.client_structure:
 
3515
                    if attr not in exclude:
 
3516
                        client_dict[attr] = getattr(client, attr)
 
3517
 
 
3518
                clients[client.name] = client_dict
 
3519
                del client_settings[client.name]["secret"]
 
3520
 
2337
3521
        try:
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:
 
3522
            with tempfile.NamedTemporaryFile(
 
3523
                    mode='wb',
 
3524
                    suffix=".pickle",
 
3525
                    prefix='clients-',
 
3526
                    dir=os.path.dirname(stored_state_path),
 
3527
                    delete=False) as stored_state:
 
3528
                pickle.dump((clients, client_settings), stored_state,
 
3529
                            protocol=2)
 
3530
                tempname = stored_state.name
 
3531
            os.rename(tempname, stored_state_path)
 
3532
        except (IOError, OSError) as e:
 
3533
            if not debug:
 
3534
                try:
 
3535
                    os.remove(tempname)
 
3536
                except NameError:
 
3537
                    pass
 
3538
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
3539
                logger.warning("Could not save persistent state: {}"
 
3540
                               .format(os.strerror(e.errno)))
 
3541
            else:
 
3542
                logger.warning("Could not save persistent state:",
 
3543
                               exc_info=e)
2347
3544
                raise
2348
3545
 
2349
3546
        # Delete all clients, and settings from config
2351
3548
            name, client = tcp_server.clients.popitem()
2352
3549
            if use_dbus:
2353
3550
                client.remove_from_connection()
2354
 
            # Don't signal anything except ClientRemoved
 
3551
            # Don't signal the disabling
2355
3552
            client.disable(quiet=True)
 
3553
            # Emit D-Bus signal for removal
2356
3554
            if use_dbus:
2357
 
                # Emit D-Bus signal
2358
 
                mandos_dbus_service.ClientRemoved(client
2359
 
                                                  .dbus_object_path,
2360
 
                                                  client.name)
 
3555
                mandos_dbus_service.client_removed_signal(client)
2361
3556
        client_settings.clear()
2362
 
    
 
3557
 
2363
3558
    atexit.register(cleanup)
2364
 
    
2365
 
    for client in tcp_server.clients.itervalues():
 
3559
 
 
3560
    for client in tcp_server.clients.values():
2366
3561
        if use_dbus:
2367
 
            # Emit D-Bus signal
2368
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3562
            # Emit D-Bus signal for adding
 
3563
            mandos_dbus_service.client_added_signal(client)
2369
3564
        # Need to initiate checking of clients
2370
3565
        if client.enabled:
2371
3566
            client.init_checker()
2372
3567
 
2373
 
    
2374
3568
    tcp_server.enable()
2375
3569
    tcp_server.server_activate()
2376
 
    
 
3570
 
2377
3571
    # Find out what port we got
2378
 
    service.port = tcp_server.socket.getsockname()[1]
 
3572
    if zeroconf:
 
3573
        service.port = tcp_server.socket.getsockname()[1]
2379
3574
    if use_ipv6:
2380
3575
        logger.info("Now listening on address %r, port %d,"
2381
 
                    " flowinfo %d, scope_id %d"
2382
 
                    % tcp_server.socket.getsockname())
 
3576
                    " flowinfo %d, scope_id %d",
 
3577
                    *tcp_server.socket.getsockname())
2383
3578
    else:                       # IPv4
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
 
    
 
3579
        logger.info("Now listening on address %r, port %d",
 
3580
                    *tcp_server.socket.getsockname())
 
3581
 
 
3582
    # service.interface = tcp_server.socket.getsockname()[3]
 
3583
 
2389
3584
    try:
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
 
        
 
3585
        if zeroconf:
 
3586
            # From the Avahi example code
 
3587
            try:
 
3588
                service.activate()
 
3589
            except dbus.exceptions.DBusException as error:
 
3590
                logger.critical("D-Bus Exception", exc_info=error)
 
3591
                cleanup()
 
3592
                sys.exit(1)
 
3593
            # End of Avahi example code
 
3594
 
 
3595
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3596
                          lambda *args, **kwargs:
 
3597
                          (tcp_server.handle_request
 
3598
                           (*args[2:], **kwargs) or True))
 
3599
 
2404
3600
        logger.debug("Starting main loop")
2405
3601
        main_loop.run()
2406
3602
    except AvahiError as error:
2407
 
        logger.critical("AvahiError: %s", error)
 
3603
        logger.critical("Avahi Error", exc_info=error)
2408
3604
        cleanup()
2409
3605
        sys.exit(1)
2410
3606
    except KeyboardInterrupt: