/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-24 06:16:09 UTC
  • Revision ID: teddy@recompile.se-20190724061609-itd0erooii5brhrn
Change URL for Avahi to use HTTPS

* INSTALL (Prerequisites/Libraries): Change URL for Avahi to
                                     "https://www.avahi.org/".
* mandos.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
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
 
    last_checker_status: integer between 0 and 255 reflecting exit status
314
 
                         of last checker. -1 reflect crashed checker,
315
 
                         or None.
316
 
    last_enabled: datetime.datetime(); (UTC)
 
847
    last_checker_status: integer between 0 and 255 reflecting exit
 
848
                         status of last checker. -1 reflects crashed
 
849
                         checker, -2 means no checker completed yet.
 
850
    last_checker_signal: The signal which killed the last checker, if
 
851
                         last_checker_status is -1
 
852
    last_enabled: datetime.datetime(); (UTC) or None
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 in self.__dict__.iterkeys() if not attr.startswith("_")]
 
969
        self.changedstate = multiprocessing_manager.Condition(
 
970
            multiprocessing_manager.Lock())
 
971
        self.client_structure = [attr
 
972
                                 for attr in self.__dict__.keys()
 
973
                                 if not attr.startswith("_")]
402
974
        self.client_structure.append("client_structure")
403
975
 
404
 
 
405
 
        for name, t in inspect.getmembers(type(self),
406
 
                                          lambda obj: isinstance(obj, property)):
 
976
        for name, t in inspect.getmembers(
 
977
                type(self), lambda obj: isinstance(obj, property)):
407
978
            if not name.startswith("_"):
408
979
                self.client_structure.append(name)
409
 
    
 
980
 
410
981
    # Send notice to process children that client state has changed
411
982
    def send_changedstate(self):
412
983
        with self.changedstate:
413
984
            self.changedstate.notify_all()
414
 
    
 
985
 
415
986
    def enable(self):
416
987
        """Start this client's checker and timeout hooks"""
417
988
        if getattr(self, "enabled", False):
418
989
            # Already enabled
419
990
            return
420
 
        self.send_changedstate()
421
991
        self.expires = datetime.datetime.utcnow() + self.timeout
422
992
        self.enabled = True
423
993
        self.last_enabled = datetime.datetime.utcnow()
424
994
        self.init_checker()
425
 
    
 
995
        self.send_changedstate()
 
996
 
426
997
    def disable(self, quiet=True):
427
998
        """Disable this client."""
428
999
        if not getattr(self, "enabled", False):
429
1000
            return False
430
1001
        if not quiet:
431
 
            self.send_changedstate()
432
 
        if not quiet:
433
1002
            logger.info("Disabling client %s", self.name)
434
 
        if getattr(self, "disable_initiator_tag", False):
435
 
            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)
436
1005
            self.disable_initiator_tag = None
437
1006
        self.expires = None
438
 
        if getattr(self, "checker_initiator_tag", False):
439
 
            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)
440
1009
            self.checker_initiator_tag = None
441
1010
        self.stop_checker()
442
1011
        self.enabled = False
443
 
        # 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
444
1015
        return False
445
 
    
 
1016
 
446
1017
    def __del__(self):
447
1018
        self.disable()
448
1019
 
449
1020
    def init_checker(self):
450
1021
        # Schedule a new checker to be started an 'interval' from now,
451
1022
        # and every interval from then on.
452
 
        self.checker_initiator_tag = (gobject.timeout_add
453
 
                                      (self.interval_milliseconds(),
454
 
                                       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)
455
1028
        # Schedule a disable() when 'timeout' has passed
456
 
        self.disable_initiator_tag = (gobject.timeout_add
457
 
                                   (self.timeout_milliseconds(),
458
 
                                    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)
459
1033
        # Also start a new checker *right now*.
460
1034
        self.start_checker()
461
1035
 
462
 
        
463
 
    def checker_callback(self, pid, condition, command):
 
1036
    def checker_callback(self, source, condition, connection,
 
1037
                         command):
464
1038
        """The checker has completed, so take appropriate actions."""
465
1039
        self.checker_callback_tag = None
466
1040
        self.checker = None
467
 
        if os.WIFEXITED(condition):
468
 
            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
469
1048
            if self.last_checker_status == 0:
470
1049
                logger.info("Checker for %(name)s succeeded",
471
1050
                            vars(self))
472
1051
                self.checked_ok()
473
1052
            else:
474
 
                logger.info("Checker for %(name)s failed",
475
 
                            vars(self))
 
1053
                logger.info("Checker for %(name)s failed", vars(self))
476
1054
        else:
477
1055
            self.last_checker_status = -1
 
1056
            self.last_checker_signal = -returncode
478
1057
            logger.warning("Checker for %(name)s crashed?",
479
1058
                           vars(self))
480
 
    
481
 
    def checked_ok(self, timeout=None):
482
 
        """Bump up the timeout for this client.
483
 
        
484
 
        This should only be called when the client has been seen,
485
 
        alive and well.
486
 
        """
 
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."""
487
1070
        if timeout is None:
488
1071
            timeout = self.timeout
489
 
        self.last_checked_ok = datetime.datetime.utcnow()
490
1072
        if self.disable_initiator_tag is not None:
491
 
            gobject.source_remove(self.disable_initiator_tag)
 
1073
            GLib.source_remove(self.disable_initiator_tag)
 
1074
            self.disable_initiator_tag = None
492
1075
        if getattr(self, "enabled", False):
493
 
            self.disable_initiator_tag = (gobject.timeout_add
494
 
                                          (_timedelta_to_milliseconds
495
 
                                           (timeout), self.disable))
 
1076
            self.disable_initiator_tag = GLib.timeout_add(
 
1077
                int(timeout.total_seconds() * 1000), self.disable)
496
1078
            self.expires = datetime.datetime.utcnow() + timeout
497
 
    
 
1079
 
498
1080
    def need_approval(self):
499
1081
        self.last_approval_request = datetime.datetime.utcnow()
500
 
    
 
1082
 
501
1083
    def start_checker(self):
502
1084
        """Start a new checker subprocess if one is not running.
503
 
        
 
1085
 
504
1086
        If a checker already exists, leave it running and do
505
1087
        nothing."""
506
1088
        # The reason for not killing a running checker is that if we
507
 
        # did that, then if a checker (for some reason) started
508
 
        # running slowly and taking more than 'interval' time, the
509
 
        # client would inevitably timeout, since no checker would get
510
 
        # 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
511
1093
        # checkers alone, the checker would have to take more time
512
1094
        # than 'timeout' for the client to be disabled, which is as it
513
1095
        # should be.
514
 
        
515
 
        # If a checker exists, make sure it is not a zombie
516
 
        try:
517
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
518
 
        except (AttributeError, OSError) as error:
519
 
            if (isinstance(error, OSError)
520
 
                and error.errno != errno.ECHILD):
521
 
                raise error
522
 
        else:
523
 
            if pid:
524
 
                logger.warning("Checker was a zombie")
525
 
                gobject.source_remove(self.checker_callback_tag)
526
 
                self.checker_callback(pid, status,
527
 
                                      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
528
1101
        # Start a new checker if needed
529
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}
530
1107
            try:
531
 
                # In case checker_command has exactly one % operator
532
 
                command = self.checker_command % self.host
533
 
            except TypeError:
534
 
                # Escape attributes for the shell
535
 
                escaped_attrs = dict(
536
 
                    (attr,
537
 
                     re.escape(unicode(str(getattr(self, attr, "")),
538
 
                                       errors=
539
 
                                       'replace')))
540
 
                    for attr in
541
 
                    self.runtime_expansions)
542
 
                
543
 
                try:
544
 
                    command = self.checker_command % escaped_attrs
545
 
                except TypeError as error:
546
 
                    logger.error('Could not format string "%s":'
547
 
                                 ' %s', self.checker_command, error)
548
 
                    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
549
1114
            self.current_checker_command = command
550
 
            try:
551
 
                logger.info("Starting checker %r for %s",
552
 
                            command, self.name)
553
 
                # We don't need to redirect stdout and stderr, since
554
 
                # in normal mode, that is already done by daemon(),
555
 
                # and in debug mode we don't want to.  (Stdin is
556
 
                # always replaced by /dev/null.)
557
 
                self.checker = subprocess.Popen(command,
558
 
                                                close_fds=True,
559
 
                                                shell=True, cwd="/")
560
 
                self.checker_callback_tag = (gobject.child_watch_add
561
 
                                             (self.checker.pid,
562
 
                                              self.checker_callback,
563
 
                                              data=command))
564
 
                # The checker may have completed before the gobject
565
 
                # watch was added.  Check for this.
566
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
567
 
                if pid:
568
 
                    gobject.source_remove(self.checker_callback_tag)
569
 
                    self.checker_callback(pid, status, command)
570
 
            except OSError as error:
571
 
                logger.error("Failed to start subprocess: %s",
572
 
                             error)
573
 
        # 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
574
1141
        return True
575
 
    
 
1142
 
576
1143
    def stop_checker(self):
577
1144
        """Force the checker process, if any, to stop."""
578
1145
        if self.checker_callback_tag:
579
 
            gobject.source_remove(self.checker_callback_tag)
 
1146
            GLib.source_remove(self.checker_callback_tag)
580
1147
            self.checker_callback_tag = None
581
1148
        if getattr(self, "checker", None) is None:
582
1149
            return
583
1150
        logger.debug("Stopping checker for %(name)s", vars(self))
584
 
        try:
585
 
            os.kill(self.checker.pid, signal.SIGTERM)
586
 
            #time.sleep(0.5)
587
 
            #if self.checker.poll() is None:
588
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
589
 
        except OSError as error:
590
 
            if error.errno != errno.ESRCH: # No such process
591
 
                raise
 
1151
        self.checker.terminate()
592
1152
        self.checker = None
593
1153
 
594
 
    # Encrypts a client secret and stores it in a varible encrypted_secret
595
 
    def encrypt_secret(self, key):
596
 
        # Encryption-key need to be of a specific size, so we hash inputed key
597
 
        hasheng = hashlib.sha256()
598
 
        hasheng.update(key)
599
 
        encryptionkey = hasheng.digest()
600
 
 
601
 
        # Create validation hash so we know at decryption if it was sucessful
602
 
        hasheng = hashlib.sha256()
603
 
        hasheng.update(self.secret)
604
 
        validationhash = hasheng.digest()
605
 
 
606
 
        # Encrypt secret
607
 
        iv = os.urandom(Crypto.Cipher.AES.block_size)
608
 
        ciphereng = Crypto.Cipher.AES.new(encryptionkey,
609
 
                                        Crypto.Cipher.AES.MODE_CFB, iv)
610
 
        ciphertext = ciphereng.encrypt(validationhash+self.secret)
611
 
        self.encrypted_secret = (ciphertext, iv)
612
 
 
613
 
    # Decrypt a encrypted client secret
614
 
    def decrypt_secret(self, key):
615
 
        # Decryption-key need to be of a specific size, so we hash inputed key
616
 
        hasheng = hashlib.sha256()
617
 
        hasheng.update(key)
618
 
        encryptionkey = hasheng.digest()
619
 
 
620
 
        # Decrypt encrypted secret
621
 
        ciphertext, iv = self.encrypted_secret
622
 
        ciphereng = Crypto.Cipher.AES.new(encryptionkey,
623
 
                                        Crypto.Cipher.AES.MODE_CFB, iv)
624
 
        plain = ciphereng.decrypt(ciphertext)
625
 
 
626
 
        # Validate decrypted secret to know if it was succesful
627
 
        hasheng = hashlib.sha256()
628
 
        validationhash = plain[:hasheng.digest_size]
629
 
        secret = plain[hasheng.digest_size:]
630
 
        hasheng.update(secret)
631
 
 
632
 
        # if validation fails, we use key as new secret. Otherwhise, we use
633
 
        # the decrypted secret
634
 
        if hasheng.digest() == validationhash:
635
 
            self.secret = secret
636
 
        else:
637
 
            self.secret = key
638
 
        del self.encrypted_secret
639
 
 
640
 
 
641
 
def dbus_service_property(dbus_interface, signature="v",
642
 
                          access="readwrite", byte_arrays=False):
 
1154
 
 
1155
def dbus_service_property(dbus_interface,
 
1156
                          signature="v",
 
1157
                          access="readwrite",
 
1158
                          byte_arrays=False):
643
1159
    """Decorators for marking methods of a DBusObjectWithProperties to
644
1160
    become properties on the D-Bus.
645
 
    
 
1161
 
646
1162
    The decorated method will be called with no arguments by "Get"
647
1163
    and with one argument by "Set".
648
 
    
 
1164
 
649
1165
    The parameters, where they are supported, are the same as
650
1166
    dbus.service.method, except there is only "signature", since the
651
1167
    type from Get() and the type sent to Set() is the same.
654
1170
    # "Set" method, so we fail early here:
655
1171
    if byte_arrays and signature != "ay":
656
1172
        raise ValueError("Byte arrays not supported for non-'ay'"
657
 
                         " signature %r" % signature)
 
1173
                         " signature {!r}".format(signature))
 
1174
 
658
1175
    def decorator(func):
659
1176
        func._dbus_is_property = True
660
1177
        func._dbus_interface = dbus_interface
663
1180
        func._dbus_name = func.__name__
664
1181
        if func._dbus_name.endswith("_dbus_property"):
665
1182
            func._dbus_name = func._dbus_name[:-14]
666
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
667
 
        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
 
668
1229
    return decorator
669
1230
 
670
1231
 
671
1232
class DBusPropertyException(dbus.exceptions.DBusException):
672
1233
    """A base class for D-Bus property-related exceptions
673
1234
    """
674
 
    def __unicode__(self):
675
 
        return unicode(str(self))
 
1235
    pass
676
1236
 
677
1237
 
678
1238
class DBusPropertyAccessException(DBusPropertyException):
687
1247
    pass
688
1248
 
689
1249
 
690
 
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):
691
1340
    """A D-Bus object with properties.
692
 
    
 
1341
 
693
1342
    Classes inheriting from this can use the dbus_service_property
694
1343
    decorator to expose methods as D-Bus properties.  It exposes the
695
1344
    standard Get(), Set(), and GetAll() methods on the D-Bus.
696
1345
    """
697
 
    
698
 
    @staticmethod
699
 
    def _is_dbus_property(obj):
700
 
        return getattr(obj, "_dbus_is_property", False)
701
 
    
702
 
    def _get_all_dbus_properties(self):
703
 
        """Returns a generator of (name, attribute) pairs
704
 
        """
705
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
706
 
                for cls in self.__class__.__mro__
707
 
                for name, prop in
708
 
                inspect.getmembers(cls, self._is_dbus_property))
709
 
    
 
1346
 
710
1347
    def _get_dbus_property(self, interface_name, property_name):
711
1348
        """Returns a bound method if one exists which is a D-Bus
712
1349
        property with the specified name and interface.
713
1350
        """
714
 
        for cls in  self.__class__.__mro__:
715
 
            for name, value in (inspect.getmembers
716
 
                                (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")):
717
1354
                if (value._dbus_name == property_name
718
1355
                    and value._dbus_interface == interface_name):
719
1356
                    return value.__get__(self)
720
 
        
 
1357
 
721
1358
        # No such property
722
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
723
 
                                   + interface_name + "."
724
 
                                   + property_name)
725
 
    
726
 
    @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",
727
1373
                         out_signature="v")
728
1374
    def Get(self, interface_name, property_name):
729
1375
        """Standard D-Bus property Get() method, see D-Bus standard.
735
1381
        if not hasattr(value, "variant_level"):
736
1382
            return value
737
1383
        return type(value)(value, variant_level=value.variant_level+1)
738
 
    
 
1384
 
739
1385
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
740
1386
    def Set(self, interface_name, property_name, value):
741
1387
        """Standard D-Bus property Set() method, see D-Bus standard.
747
1393
            # The byte_arrays option is not supported yet on
748
1394
            # signatures other than "ay".
749
1395
            if prop._dbus_signature != "ay":
750
 
                raise ValueError
751
 
            value = dbus.ByteArray(''.join(unichr(byte)
752
 
                                           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))
753
1401
        prop(value)
754
 
    
755
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1402
 
 
1403
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1404
                         in_signature="s",
756
1405
                         out_signature="a{sv}")
757
1406
    def GetAll(self, interface_name):
758
1407
        """Standard D-Bus property GetAll() method, see D-Bus
759
1408
        standard.
760
 
        
 
1409
 
761
1410
        Note: Will not include properties with access="write".
762
1411
        """
763
 
        all = {}
764
 
        for name, prop in self._get_all_dbus_properties():
 
1412
        properties = {}
 
1413
        for name, prop in self._get_all_dbus_things("property"):
765
1414
            if (interface_name
766
1415
                and interface_name != prop._dbus_interface):
767
1416
                # Interface non-empty but did not match
771
1420
                continue
772
1421
            value = prop()
773
1422
            if not hasattr(value, "variant_level"):
774
 
                all[name] = value
 
1423
                properties[name] = value
775
1424
                continue
776
 
            all[name] = type(value)(value, variant_level=
777
 
                                    value.variant_level+1)
778
 
        return dbus.Dictionary(all, signature="sv")
779
 
    
 
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
 
780
1437
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
781
1438
                         out_signature="s",
782
1439
                         path_keyword='object_path',
783
1440
                         connection_keyword='connection')
784
1441
    def Introspect(self, object_path, connection):
785
 
        """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.
786
1445
        """
787
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
788
 
                                                   connection)
 
1446
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1447
                                                         object_path,
 
1448
                                                         connection)
789
1449
        try:
790
1450
            document = xml.dom.minidom.parseString(xmlstring)
 
1451
 
791
1452
            def make_tag(document, name, prop):
792
1453
                e = document.createElement("property")
793
1454
                e.setAttribute("name", name)
794
1455
                e.setAttribute("type", prop._dbus_signature)
795
1456
                e.setAttribute("access", prop._dbus_access)
796
1457
                return e
 
1458
 
797
1459
            for if_tag in document.getElementsByTagName("interface"):
 
1460
                # Add property tags
798
1461
                for tag in (make_tag(document, name, prop)
799
1462
                            for name, prop
800
 
                            in self._get_all_dbus_properties()
 
1463
                            in self._get_all_dbus_things("property")
801
1464
                            if prop._dbus_interface
802
1465
                            == if_tag.getAttribute("name")):
803
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)
804
1483
                # Add the names to the return values for the
805
1484
                # "org.freedesktop.DBus.Properties" methods
806
1485
                if (if_tag.getAttribute("name")
821
1500
        except (AttributeError, xml.dom.DOMException,
822
1501
                xml.parsers.expat.ExpatError) as error:
823
1502
            logger.error("Failed to override Introspection method",
824
 
                         error)
825
 
        return xmlstring
826
 
 
827
 
 
828
 
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):
829
1579
    """Convert a UTC datetime.datetime() to a D-Bus type."""
830
1580
    if dt is None:
831
 
        return dbus.String("", variant_level = variant_level)
832
 
    return dbus.String(dt.isoformat(),
833
 
                       variant_level=variant_level)
834
 
 
835
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
836
 
                                  .__metaclass__):
837
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
838
 
    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).
839
1607
    """
840
 
    def __new__(mcs, name, bases, attr):
841
 
        # Go through all the base classes which could have D-Bus
842
 
        # methods, signals, or properties in them
843
 
        for base in (b for b in bases
844
 
                     if issubclass(b, dbus.service.Object)):
845
 
            # Go though all attributes of the base class
846
 
            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):
847
1616
                # Ignore non-D-Bus attributes, and D-Bus attributes
848
1617
                # with the wrong interface name
849
1618
                if (not hasattr(attribute, "_dbus_interface")
850
 
                    or not attribute._dbus_interface
851
 
                    .startswith("se.recompile.Mandos")):
 
1619
                    or not attribute._dbus_interface.startswith(
 
1620
                        orig_interface_name)):
852
1621
                    continue
853
1622
                # Create an alternate D-Bus interface name based on
854
1623
                # the current name
855
 
                alt_interface = (attribute._dbus_interface
856
 
                                 .replace("se.recompile.Mandos",
857
 
                                          "se.bsnet.fukt.Mandos"))
 
1624
                alt_interface = attribute._dbus_interface.replace(
 
1625
                    orig_interface_name, alt_interface_name)
 
1626
                interface_names.add(alt_interface)
858
1627
                # Is this a D-Bus signal?
859
1628
                if getattr(attribute, "_dbus_is_signal", False):
860
 
                    # Extract the original non-method function by
861
 
                    # black magic
862
 
                    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(
863
1633
                            zip(attribute.func_code.co_freevars,
864
 
                                attribute.__closure__))["func"]
865
 
                                      .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)
866
1641
                    # Create a new, but exactly alike, function
867
1642
                    # object, and decorate it to be a new D-Bus signal
868
1643
                    # with the alternate D-Bus interface name
869
 
                    new_function = (dbus.service.signal
870
 
                                    (alt_interface,
871
 
                                     attribute._dbus_signature)
872
 
                                    (types.FunctionType(
873
 
                                nonmethod_func.func_code,
874
 
                                nonmethod_func.func_globals,
875
 
                                nonmethod_func.func_name,
876
 
                                nonmethod_func.func_defaults,
877
 
                                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
 
878
1655
                    # Define a creator of a function to call both the
879
 
                    # old and new functions, so both the old and new
880
 
                    # 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
881
1659
                    def fixscope(func1, func2):
882
1660
                        """This function is a scope container to pass
883
1661
                        func1 and func2 to the "call_both" function
884
1662
                        outside of its arguments"""
 
1663
 
 
1664
                        @functools.wraps(func2)
885
1665
                        def call_both(*args, **kwargs):
886
1666
                            """This function will emit two D-Bus
887
1667
                            signals by calling func1 and func2"""
888
1668
                            func1(*args, **kwargs)
889
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
 
890
1676
                        return call_both
891
1677
                    # Create the "call_both" function and add it to
892
1678
                    # the class
893
 
                    attr[attrname] = fixscope(attribute,
894
 
                                              new_function)
 
1679
                    attr[attrname] = fixscope(attribute, new_function)
895
1680
                # Is this a D-Bus method?
896
1681
                elif getattr(attribute, "_dbus_is_method", False):
897
1682
                    # Create a new, but exactly alike, function
898
1683
                    # object.  Decorate it to be a new D-Bus method
899
1684
                    # with the alternate D-Bus interface name.  Add it
900
1685
                    # to the class.
901
 
                    attr[attrname] = (dbus.service.method
902
 
                                      (alt_interface,
903
 
                                       attribute._dbus_in_signature,
904
 
                                       attribute._dbus_out_signature)
905
 
                                      (types.FunctionType
906
 
                                       (attribute.func_code,
907
 
                                        attribute.func_globals,
908
 
                                        attribute.func_name,
909
 
                                        attribute.func_defaults,
910
 
                                        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
911
1698
                # Is this a D-Bus property?
912
1699
                elif getattr(attribute, "_dbus_is_property", False):
913
1700
                    # Create a new, but exactly alike, function
914
1701
                    # object, and decorate it to be a new D-Bus
915
1702
                    # property with the alternate D-Bus interface
916
1703
                    # name.  Add it to the class.
917
 
                    attr[attrname] = (dbus_service_property
918
 
                                      (alt_interface,
919
 
                                       attribute._dbus_signature,
920
 
                                       attribute._dbus_access,
921
 
                                       attribute
922
 
                                       ._dbus_get_args_options
923
 
                                       ["byte_arrays"])
924
 
                                      (types.FunctionType
925
 
                                       (attribute.func_code,
926
 
                                        attribute.func_globals,
927
 
                                        attribute.func_name,
928
 
                                        attribute.func_defaults,
929
 
                                        attribute.func_closure)))
930
 
        return type.__new__(mcs, name, bases, attr)
931
 
 
 
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"})
932
1756
class ClientDBus(Client, DBusObjectWithProperties):
933
1757
    """A Client class using D-Bus
934
 
    
 
1758
 
935
1759
    Attributes:
936
1760
    dbus_object_path: dbus.ObjectPath
937
1761
    bus: dbus.SystemBus()
938
1762
    """
939
 
    
 
1763
 
940
1764
    runtime_expansions = (Client.runtime_expansions
941
 
                          + ("dbus_object_path",))
942
 
    
 
1765
                          + ("dbus_object_path", ))
 
1766
 
 
1767
    _interface = "se.recompile.Mandos.Client"
 
1768
 
943
1769
    # dbus.service.Object doesn't use super(), so we can't either.
944
 
    
945
 
    def __init__(self, bus = None, *args, **kwargs):
 
1770
 
 
1771
    def __init__(self, bus=None, *args, **kwargs):
946
1772
        self.bus = bus
947
1773
        Client.__init__(self, *args, **kwargs)
948
 
 
949
 
        self._approvals_pending = 0
950
1774
        # Only now, when this client is initialized, can it show up on
951
1775
        # the D-Bus
952
 
        client_object_name = unicode(self.name).translate(
 
1776
        client_object_name = str(self.name).translate(
953
1777
            {ord("."): ord("_"),
954
1778
             ord("-"): ord("_")})
955
 
        self.dbus_object_path = (dbus.ObjectPath
956
 
                                 ("/clients/" + client_object_name))
 
1779
        self.dbus_object_path = dbus.ObjectPath(
 
1780
            "/clients/" + client_object_name)
957
1781
        DBusObjectWithProperties.__init__(self, self.bus,
958
1782
                                          self.dbus_object_path)
959
 
        
960
 
    def notifychangeproperty(transform_func,
961
 
                             dbus_name, type_func=lambda x: x,
962
 
                             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):
963
1789
        """ Modify a variable so that it's a property which announces
964
1790
        its changes to DBus.
965
1791
 
970
1796
                   to the D-Bus.  Default: no transform
971
1797
        variant_level: D-Bus variant level.  Default: 1
972
1798
        """
973
 
        attrname = "_{0}".format(dbus_name)
 
1799
        attrname = "_{}".format(dbus_name)
 
1800
 
974
1801
        def setter(self, value):
975
1802
            if hasattr(self, "dbus_object_path"):
976
1803
                if (not hasattr(self, attrname) or
977
1804
                    type_func(getattr(self, attrname, None))
978
1805
                    != type_func(value)):
979
 
                    dbus_value = transform_func(type_func(value),
980
 
                                                variant_level
981
 
                                                =variant_level)
982
 
                    self.PropertyChanged(dbus.String(dbus_name),
983
 
                                         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())
984
1821
            setattr(self, attrname, value)
985
 
        
 
1822
 
986
1823
        return property(lambda self: getattr(self, attrname), setter)
987
 
    
988
 
    
 
1824
 
989
1825
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
990
1826
    approvals_pending = notifychangeproperty(dbus.Boolean,
991
1827
                                             "ApprovalPending",
992
 
                                             type_func = bool)
 
1828
                                             type_func=bool)
993
1829
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
994
1830
    last_enabled = notifychangeproperty(datetime_to_dbus,
995
1831
                                        "LastEnabled")
996
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
997
 
                                   type_func = lambda checker:
998
 
                                       checker is not None)
 
1832
    checker = notifychangeproperty(
 
1833
        dbus.Boolean, "CheckerRunning",
 
1834
        type_func=lambda checker: checker is not None)
999
1835
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1000
1836
                                           "LastCheckedOK")
 
1837
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1838
                                               "LastCheckerStatus")
1001
1839
    last_approval_request = notifychangeproperty(
1002
1840
        datetime_to_dbus, "LastApprovalRequest")
1003
1841
    approved_by_default = notifychangeproperty(dbus.Boolean,
1004
1842
                                               "ApprovedByDefault")
1005
 
    approval_delay = notifychangeproperty(dbus.UInt16,
1006
 
                                          "ApprovalDelay",
1007
 
                                          type_func =
1008
 
                                          _timedelta_to_milliseconds)
 
1843
    approval_delay = notifychangeproperty(
 
1844
        dbus.UInt64, "ApprovalDelay",
 
1845
        type_func=lambda td: td.total_seconds() * 1000)
1009
1846
    approval_duration = notifychangeproperty(
1010
 
        dbus.UInt16, "ApprovalDuration",
1011
 
        type_func = _timedelta_to_milliseconds)
 
1847
        dbus.UInt64, "ApprovalDuration",
 
1848
        type_func=lambda td: td.total_seconds() * 1000)
1012
1849
    host = notifychangeproperty(dbus.String, "Host")
1013
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1014
 
                                   type_func =
1015
 
                                   _timedelta_to_milliseconds)
 
1850
    timeout = notifychangeproperty(
 
1851
        dbus.UInt64, "Timeout",
 
1852
        type_func=lambda td: td.total_seconds() * 1000)
1016
1853
    extended_timeout = notifychangeproperty(
1017
 
        dbus.UInt16, "ExtendedTimeout",
1018
 
        type_func = _timedelta_to_milliseconds)
1019
 
    interval = notifychangeproperty(dbus.UInt16,
1020
 
                                    "Interval",
1021
 
                                    type_func =
1022
 
                                    _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)
1023
1859
    checker_command = notifychangeproperty(dbus.String, "Checker")
1024
 
    
 
1860
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1861
                                  invalidate_only=True)
 
1862
 
1025
1863
    del notifychangeproperty
1026
 
    
 
1864
 
1027
1865
    def __del__(self, *args, **kwargs):
1028
1866
        try:
1029
1867
            self.remove_from_connection()
1032
1870
        if hasattr(DBusObjectWithProperties, "__del__"):
1033
1871
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1034
1872
        Client.__del__(self, *args, **kwargs)
1035
 
    
1036
 
    def checker_callback(self, pid, condition, command,
1037
 
                         *args, **kwargs):
1038
 
        self.checker_callback_tag = None
1039
 
        self.checker = None
1040
 
        if os.WIFEXITED(condition):
1041
 
            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:
1042
1881
            # Emit D-Bus signal
1043
1882
            self.CheckerCompleted(dbus.Int16(exitstatus),
1044
 
                                  dbus.Int64(condition),
 
1883
                                  # This is specific to GNU libC
 
1884
                                  dbus.Int64(exitstatus << 8),
1045
1885
                                  dbus.String(command))
1046
1886
        else:
1047
1887
            # Emit D-Bus signal
1048
1888
            self.CheckerCompleted(dbus.Int16(-1),
1049
 
                                  dbus.Int64(condition),
 
1889
                                  dbus.Int64(
 
1890
                                      # This is specific to GNU libC
 
1891
                                      (exitstatus << 8)
 
1892
                                      | self.last_checker_signal),
1050
1893
                                  dbus.String(command))
1051
 
        
1052
 
        return Client.checker_callback(self, pid, condition, command,
1053
 
                                       *args, **kwargs)
1054
 
    
 
1894
        return ret
 
1895
 
1055
1896
    def start_checker(self, *args, **kwargs):
1056
 
        old_checker = self.checker
1057
 
        if self.checker is not None:
1058
 
            old_checker_pid = self.checker.pid
1059
 
        else:
1060
 
            old_checker_pid = None
 
1897
        old_checker_pid = getattr(self.checker, "pid", None)
1061
1898
        r = Client.start_checker(self, *args, **kwargs)
1062
1899
        # Only if new checker process was started
1063
1900
        if (self.checker is not None
1065
1902
            # Emit D-Bus signal
1066
1903
            self.CheckerStarted(self.current_checker_command)
1067
1904
        return r
1068
 
    
 
1905
 
1069
1906
    def _reset_approved(self):
1070
 
        self._approved = None
 
1907
        self.approved = None
1071
1908
        return False
1072
 
    
 
1909
 
1073
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)
1074
1914
        self.send_changedstate()
1075
 
        self._approved = value
1076
 
        gobject.timeout_add(_timedelta_to_milliseconds
1077
 
                            (self.approval_duration),
1078
 
                            self._reset_approved)
1079
 
    
1080
 
    
1081
 
    ## D-Bus methods, signals & properties
1082
 
    _interface = "se.recompile.Mandos.Client"
1083
 
    
1084
 
    ## Signals
1085
 
    
 
1915
 
 
1916
    #  D-Bus methods, signals & properties
 
1917
 
 
1918
    #  Interfaces
 
1919
 
 
1920
    #  Signals
 
1921
 
1086
1922
    # CheckerCompleted - signal
1087
1923
    @dbus.service.signal(_interface, signature="nxs")
1088
1924
    def CheckerCompleted(self, exitcode, waitstatus, command):
1089
1925
        "D-Bus signal"
1090
1926
        pass
1091
 
    
 
1927
 
1092
1928
    # CheckerStarted - signal
1093
1929
    @dbus.service.signal(_interface, signature="s")
1094
1930
    def CheckerStarted(self, command):
1095
1931
        "D-Bus signal"
1096
1932
        pass
1097
 
    
 
1933
 
1098
1934
    # PropertyChanged - signal
 
1935
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1099
1936
    @dbus.service.signal(_interface, signature="sv")
1100
1937
    def PropertyChanged(self, property, value):
1101
1938
        "D-Bus signal"
1102
1939
        pass
1103
 
    
 
1940
 
1104
1941
    # GotSecret - signal
1105
1942
    @dbus.service.signal(_interface)
1106
1943
    def GotSecret(self):
1109
1946
        server to mandos-client
1110
1947
        """
1111
1948
        pass
1112
 
    
 
1949
 
1113
1950
    # Rejected - signal
1114
1951
    @dbus.service.signal(_interface, signature="s")
1115
1952
    def Rejected(self, reason):
1116
1953
        "D-Bus signal"
1117
1954
        pass
1118
 
    
 
1955
 
1119
1956
    # NeedApproval - signal
1120
1957
    @dbus.service.signal(_interface, signature="tb")
1121
1958
    def NeedApproval(self, timeout, default):
1122
1959
        "D-Bus signal"
1123
1960
        return self.need_approval()
1124
 
    
1125
 
    ## Methods
1126
 
    
 
1961
 
 
1962
    #  Methods
 
1963
 
1127
1964
    # Approve - method
1128
1965
    @dbus.service.method(_interface, in_signature="b")
1129
1966
    def Approve(self, value):
1130
1967
        self.approve(value)
1131
 
    
 
1968
 
1132
1969
    # CheckedOK - method
1133
1970
    @dbus.service.method(_interface)
1134
1971
    def CheckedOK(self):
1135
1972
        self.checked_ok()
1136
 
    
 
1973
 
1137
1974
    # Enable - method
 
1975
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1138
1976
    @dbus.service.method(_interface)
1139
1977
    def Enable(self):
1140
1978
        "D-Bus method"
1141
1979
        self.enable()
1142
 
    
 
1980
 
1143
1981
    # StartChecker - method
 
1982
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1144
1983
    @dbus.service.method(_interface)
1145
1984
    def StartChecker(self):
1146
1985
        "D-Bus method"
1147
1986
        self.start_checker()
1148
 
    
 
1987
 
1149
1988
    # Disable - method
 
1989
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1150
1990
    @dbus.service.method(_interface)
1151
1991
    def Disable(self):
1152
1992
        "D-Bus method"
1153
1993
        self.disable()
1154
 
    
 
1994
 
1155
1995
    # StopChecker - method
 
1996
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1156
1997
    @dbus.service.method(_interface)
1157
1998
    def StopChecker(self):
1158
1999
        self.stop_checker()
1159
 
    
1160
 
    ## Properties
1161
 
    
 
2000
 
 
2001
    #  Properties
 
2002
 
1162
2003
    # ApprovalPending - property
1163
2004
    @dbus_service_property(_interface, signature="b", access="read")
1164
2005
    def ApprovalPending_dbus_property(self):
1165
2006
        return dbus.Boolean(bool(self.approvals_pending))
1166
 
    
 
2007
 
1167
2008
    # ApprovedByDefault - property
1168
 
    @dbus_service_property(_interface, signature="b",
 
2009
    @dbus_service_property(_interface,
 
2010
                           signature="b",
1169
2011
                           access="readwrite")
1170
2012
    def ApprovedByDefault_dbus_property(self, value=None):
1171
2013
        if value is None:       # get
1172
2014
            return dbus.Boolean(self.approved_by_default)
1173
2015
        self.approved_by_default = bool(value)
1174
 
    
 
2016
 
1175
2017
    # ApprovalDelay - property
1176
 
    @dbus_service_property(_interface, signature="t",
 
2018
    @dbus_service_property(_interface,
 
2019
                           signature="t",
1177
2020
                           access="readwrite")
1178
2021
    def ApprovalDelay_dbus_property(self, value=None):
1179
2022
        if value is None:       # get
1180
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
2023
            return dbus.UInt64(self.approval_delay.total_seconds()
 
2024
                               * 1000)
1181
2025
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1182
 
    
 
2026
 
1183
2027
    # ApprovalDuration - property
1184
 
    @dbus_service_property(_interface, signature="t",
 
2028
    @dbus_service_property(_interface,
 
2029
                           signature="t",
1185
2030
                           access="readwrite")
1186
2031
    def ApprovalDuration_dbus_property(self, value=None):
1187
2032
        if value is None:       # get
1188
 
            return dbus.UInt64(_timedelta_to_milliseconds(
1189
 
                    self.approval_duration))
 
2033
            return dbus.UInt64(self.approval_duration.total_seconds()
 
2034
                               * 1000)
1190
2035
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1191
 
    
 
2036
 
1192
2037
    # Name - property
 
2038
    @dbus_annotations(
 
2039
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1193
2040
    @dbus_service_property(_interface, signature="s", access="read")
1194
2041
    def Name_dbus_property(self):
1195
2042
        return dbus.String(self.name)
1196
 
    
 
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
 
1197
2051
    # Fingerprint - property
 
2052
    @dbus_annotations(
 
2053
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1198
2054
    @dbus_service_property(_interface, signature="s", access="read")
1199
2055
    def Fingerprint_dbus_property(self):
1200
2056
        return dbus.String(self.fingerprint)
1201
 
    
 
2057
 
1202
2058
    # Host - property
1203
 
    @dbus_service_property(_interface, signature="s",
 
2059
    @dbus_service_property(_interface,
 
2060
                           signature="s",
1204
2061
                           access="readwrite")
1205
2062
    def Host_dbus_property(self, value=None):
1206
2063
        if value is None:       # get
1207
2064
            return dbus.String(self.host)
1208
 
        self.host = value
1209
 
    
 
2065
        self.host = str(value)
 
2066
 
1210
2067
    # Created - property
 
2068
    @dbus_annotations(
 
2069
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1211
2070
    @dbus_service_property(_interface, signature="s", access="read")
1212
2071
    def Created_dbus_property(self):
1213
 
        return dbus.String(datetime_to_dbus(self.created))
1214
 
    
 
2072
        return datetime_to_dbus(self.created)
 
2073
 
1215
2074
    # LastEnabled - property
1216
2075
    @dbus_service_property(_interface, signature="s", access="read")
1217
2076
    def LastEnabled_dbus_property(self):
1218
2077
        return datetime_to_dbus(self.last_enabled)
1219
 
    
 
2078
 
1220
2079
    # Enabled - property
1221
 
    @dbus_service_property(_interface, signature="b",
 
2080
    @dbus_service_property(_interface,
 
2081
                           signature="b",
1222
2082
                           access="readwrite")
1223
2083
    def Enabled_dbus_property(self, value=None):
1224
2084
        if value is None:       # get
1227
2087
            self.enable()
1228
2088
        else:
1229
2089
            self.disable()
1230
 
    
 
2090
 
1231
2091
    # LastCheckedOK - property
1232
 
    @dbus_service_property(_interface, signature="s",
 
2092
    @dbus_service_property(_interface,
 
2093
                           signature="s",
1233
2094
                           access="readwrite")
1234
2095
    def LastCheckedOK_dbus_property(self, value=None):
1235
2096
        if value is not None:
1236
2097
            self.checked_ok()
1237
2098
            return
1238
2099
        return datetime_to_dbus(self.last_checked_ok)
1239
 
    
 
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
 
1240
2106
    # Expires - property
1241
2107
    @dbus_service_property(_interface, signature="s", access="read")
1242
2108
    def Expires_dbus_property(self):
1243
2109
        return datetime_to_dbus(self.expires)
1244
 
    
 
2110
 
1245
2111
    # LastApprovalRequest - property
1246
2112
    @dbus_service_property(_interface, signature="s", access="read")
1247
2113
    def LastApprovalRequest_dbus_property(self):
1248
2114
        return datetime_to_dbus(self.last_approval_request)
1249
 
    
 
2115
 
1250
2116
    # Timeout - property
1251
 
    @dbus_service_property(_interface, signature="t",
 
2117
    @dbus_service_property(_interface,
 
2118
                           signature="t",
1252
2119
                           access="readwrite")
1253
2120
    def Timeout_dbus_property(self, value=None):
1254
2121
        if value is None:       # get
1255
 
            return dbus.UInt64(self.timeout_milliseconds())
 
2122
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
2123
        old_timeout = self.timeout
1256
2124
        self.timeout = datetime.timedelta(0, 0, 0, value)
1257
 
        if getattr(self, "disable_initiator_tag", None) is None:
1258
 
            return
1259
 
        # Reschedule timeout
1260
 
        gobject.source_remove(self.disable_initiator_tag)
1261
 
        self.disable_initiator_tag = None
1262
 
        self.expires = None
1263
 
        time_to_die = _timedelta_to_milliseconds((self
1264
 
                                                  .last_checked_ok
1265
 
                                                  + self.timeout)
1266
 
                                                 - datetime.datetime
1267
 
                                                 .utcnow())
1268
 
        if time_to_die <= 0:
1269
 
            # The timeout has passed
1270
 
            self.disable()
1271
 
        else:
1272
 
            self.expires = (datetime.datetime.utcnow()
1273
 
                            + datetime.timedelta(milliseconds =
1274
 
                                                 time_to_die))
1275
 
            self.disable_initiator_tag = (gobject.timeout_add
1276
 
                                          (time_to_die, self.disable))
1277
 
    
 
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
 
1278
2141
    # ExtendedTimeout - property
1279
 
    @dbus_service_property(_interface, signature="t",
 
2142
    @dbus_service_property(_interface,
 
2143
                           signature="t",
1280
2144
                           access="readwrite")
1281
2145
    def ExtendedTimeout_dbus_property(self, value=None):
1282
2146
        if value is None:       # get
1283
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
2147
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
2148
                               * 1000)
1284
2149
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1285
 
    
 
2150
 
1286
2151
    # Interval - property
1287
 
    @dbus_service_property(_interface, signature="t",
 
2152
    @dbus_service_property(_interface,
 
2153
                           signature="t",
1288
2154
                           access="readwrite")
1289
2155
    def Interval_dbus_property(self, value=None):
1290
2156
        if value is None:       # get
1291
 
            return dbus.UInt64(self.interval_milliseconds())
 
2157
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1292
2158
        self.interval = datetime.timedelta(0, 0, 0, value)
1293
2159
        if getattr(self, "checker_initiator_tag", None) is None:
1294
2160
            return
1295
 
        # Reschedule checker run
1296
 
        gobject.source_remove(self.checker_initiator_tag)
1297
 
        self.checker_initiator_tag = (gobject.timeout_add
1298
 
                                      (value, self.start_checker))
1299
 
        self.start_checker()    # Start one now, too
1300
 
    
 
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
 
1301
2168
    # Checker - property
1302
 
    @dbus_service_property(_interface, signature="s",
 
2169
    @dbus_service_property(_interface,
 
2170
                           signature="s",
1303
2171
                           access="readwrite")
1304
2172
    def Checker_dbus_property(self, value=None):
1305
2173
        if value is None:       # get
1306
2174
            return dbus.String(self.checker_command)
1307
 
        self.checker_command = value
1308
 
    
 
2175
        self.checker_command = str(value)
 
2176
 
1309
2177
    # CheckerRunning - property
1310
 
    @dbus_service_property(_interface, signature="b",
 
2178
    @dbus_service_property(_interface,
 
2179
                           signature="b",
1311
2180
                           access="readwrite")
1312
2181
    def CheckerRunning_dbus_property(self, value=None):
1313
2182
        if value is None:       # get
1316
2185
            self.start_checker()
1317
2186
        else:
1318
2187
            self.stop_checker()
1319
 
    
 
2188
 
1320
2189
    # ObjectPath - property
 
2190
    @dbus_annotations(
 
2191
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2192
         "org.freedesktop.DBus.Deprecated": "true"})
1321
2193
    @dbus_service_property(_interface, signature="o", access="read")
1322
2194
    def ObjectPath_dbus_property(self):
1323
 
        return self.dbus_object_path # is already a dbus.ObjectPath
1324
 
    
 
2195
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
2196
 
1325
2197
    # Secret = property
1326
 
    @dbus_service_property(_interface, signature="ay",
1327
 
                           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)
1328
2205
    def Secret_dbus_property(self, value):
1329
 
        self.secret = str(value)
1330
 
    
 
2206
        self.secret = bytes(value)
 
2207
 
1331
2208
    del _interface
1332
2209
 
1333
2210
 
1334
2211
class ProxyClient(object):
1335
 
    def __init__(self, child_pipe, fpr, address):
 
2212
    def __init__(self, child_pipe, key_id, fpr, address):
1336
2213
        self._pipe = child_pipe
1337
 
        self._pipe.send(('init', fpr, address))
 
2214
        self._pipe.send(('init', key_id, fpr, address))
1338
2215
        if not self._pipe.recv():
1339
 
            raise KeyError()
1340
 
    
 
2216
            raise KeyError(key_id or fpr)
 
2217
 
1341
2218
    def __getattribute__(self, name):
1342
 
        if(name == '_pipe'):
 
2219
        if name == '_pipe':
1343
2220
            return super(ProxyClient, self).__getattribute__(name)
1344
2221
        self._pipe.send(('getattr', name))
1345
2222
        data = self._pipe.recv()
1346
2223
        if data[0] == 'data':
1347
2224
            return data[1]
1348
2225
        if data[0] == 'function':
 
2226
 
1349
2227
            def func(*args, **kwargs):
1350
2228
                self._pipe.send(('funcall', name, args, kwargs))
1351
2229
                return self._pipe.recv()[1]
 
2230
 
1352
2231
            return func
1353
 
    
 
2232
 
1354
2233
    def __setattr__(self, name, value):
1355
 
        if(name == '_pipe'):
 
2234
        if name == '_pipe':
1356
2235
            return super(ProxyClient, self).__setattr__(name, value)
1357
2236
        self._pipe.send(('setattr', name, value))
1358
2237
 
1359
 
class ClientDBusTransitional(ClientDBus):
1360
 
    __metaclass__ = AlternateDBusNamesMetaclass
1361
2238
 
1362
2239
class ClientHandler(socketserver.BaseRequestHandler, object):
1363
2240
    """A class to handle client connections.
1364
 
    
 
2241
 
1365
2242
    Instantiated once for each connection to handle it.
1366
2243
    Note: This will run in its own forked process."""
1367
 
    
 
2244
 
1368
2245
    def handle(self):
1369
2246
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1370
2247
            logger.info("TCP connection from: %s",
1371
 
                        unicode(self.client_address))
 
2248
                        str(self.client_address))
1372
2249
            logger.debug("Pipe FD: %d",
1373
2250
                         self.server.child_pipe.fileno())
1374
 
            
1375
 
            session = (gnutls.connection
1376
 
                       .ClientSession(self.request,
1377
 
                                      gnutls.connection
1378
 
                                      .X509Credentials()))
1379
 
            
1380
 
            # Note: gnutls.connection.X509Credentials is really a
1381
 
            # generic GnuTLS certificate credentials object so long as
1382
 
            # no X.509 keys are added to it.  Therefore, we can use it
1383
 
            # here despite using OpenPGP certificates.
1384
 
            
1385
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1386
 
            #                      "+AES-256-CBC", "+SHA1",
1387
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1388
 
            #                      "+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"))
1389
2258
            # Use a fallback default, since this MUST be set.
1390
2259
            priority = self.server.gnutls_priority
1391
2260
            if priority is None:
1392
2261
                priority = "NORMAL"
1393
 
            (gnutls.library.functions
1394
 
             .gnutls_priority_set_direct(session._c_object,
1395
 
                                         priority, None))
1396
 
            
 
2262
            gnutls.priority_set_direct(session._c_object,
 
2263
                                       priority.encode("utf-8"),
 
2264
                                       None)
 
2265
 
1397
2266
            # Start communication using the Mandos protocol
1398
2267
            # Get protocol number
1399
2268
            line = self.request.makefile().readline()
1400
2269
            logger.debug("Protocol version: %r", line)
1401
2270
            try:
1402
2271
                if int(line.strip().split()[0]) > 1:
1403
 
                    raise RuntimeError
 
2272
                    raise RuntimeError(line)
1404
2273
            except (ValueError, IndexError, RuntimeError) as error:
1405
2274
                logger.error("Unknown protocol version: %s", error)
1406
2275
                return
1407
 
            
 
2276
 
1408
2277
            # Start GnuTLS connection
1409
2278
            try:
1410
2279
                session.handshake()
1411
 
            except gnutls.errors.GNUTLSError as error:
 
2280
            except gnutls.Error as error:
1412
2281
                logger.warning("Handshake failed: %s", error)
1413
2282
                # Do not run session.bye() here: the session is not
1414
2283
                # established.  Just abandon the request.
1415
2284
                return
1416
2285
            logger.debug("Handshake succeeded")
1417
 
            
 
2286
 
1418
2287
            approval_required = False
1419
2288
            try:
1420
 
                try:
1421
 
                    fpr = self.fingerprint(self.peer_certificate
1422
 
                                           (session))
1423
 
                except (TypeError,
1424
 
                        gnutls.errors.GNUTLSError) as error:
1425
 
                    logger.warning("Bad certificate: %s", error)
1426
 
                    return
1427
 
                logger.debug("Fingerprint: %s", fpr)
1428
 
                
1429
 
                try:
1430
 
                    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,
1431
2311
                                         self.client_address)
1432
2312
                except KeyError:
1433
2313
                    return
1434
 
                
 
2314
 
1435
2315
                if client.approval_delay:
1436
2316
                    delay = client.approval_delay
1437
2317
                    client.approvals_pending += 1
1438
2318
                    approval_required = True
1439
 
                
 
2319
 
1440
2320
                while True:
1441
2321
                    if not client.enabled:
1442
2322
                        logger.info("Client %s is disabled",
1443
 
                                       client.name)
 
2323
                                    client.name)
1444
2324
                        if self.server.use_dbus:
1445
2325
                            # Emit D-Bus signal
1446
2326
                            client.Rejected("Disabled")
1447
2327
                        return
1448
 
                    
1449
 
                    if client._approved or not client.approval_delay:
1450
 
                        #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
1451
2331
                        break
1452
 
                    elif client._approved is None:
 
2332
                    elif client.approved is None:
1453
2333
                        logger.info("Client %s needs approval",
1454
2334
                                    client.name)
1455
2335
                        if self.server.use_dbus:
1456
2336
                            # Emit D-Bus signal
1457
2337
                            client.NeedApproval(
1458
 
                                client.approval_delay_milliseconds(),
1459
 
                                client.approved_by_default)
 
2338
                                client.approval_delay.total_seconds()
 
2339
                                * 1000, client.approved_by_default)
1460
2340
                    else:
1461
2341
                        logger.warning("Client %s was not approved",
1462
2342
                                       client.name)
1464
2344
                            # Emit D-Bus signal
1465
2345
                            client.Rejected("Denied")
1466
2346
                        return
1467
 
                    
1468
 
                    #wait until timeout or approved
 
2347
 
 
2348
                    # wait until timeout or approved
1469
2349
                    time = datetime.datetime.now()
1470
2350
                    client.changedstate.acquire()
1471
 
                    (client.changedstate.wait
1472
 
                     (float(client._timedelta_to_milliseconds(delay)
1473
 
                            / 1000)))
 
2351
                    client.changedstate.wait(delay.total_seconds())
1474
2352
                    client.changedstate.release()
1475
2353
                    time2 = datetime.datetime.now()
1476
2354
                    if (time2 - time) >= delay:
1486
2364
                            break
1487
2365
                    else:
1488
2366
                        delay -= time2 - time
1489
 
                
1490
 
                sent_size = 0
1491
 
                while sent_size < len(client.secret):
1492
 
                    try:
1493
 
                        sent = session.send(client.secret[sent_size:])
1494
 
                    except gnutls.errors.GNUTLSError as error:
1495
 
                        logger.warning("gnutls send failed")
1496
 
                        return
1497
 
                    logger.debug("Sent: %d, remaining: %d",
1498
 
                                 sent, len(client.secret)
1499
 
                                 - (sent_size + sent))
1500
 
                    sent_size += sent
1501
 
                
 
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
 
1502
2375
                logger.info("Sending secret to %s", client.name)
1503
2376
                # bump the timeout using extended_timeout
1504
 
                client.checked_ok(client.extended_timeout)
 
2377
                client.bump_timeout(client.extended_timeout)
1505
2378
                if self.server.use_dbus:
1506
2379
                    # Emit D-Bus signal
1507
2380
                    client.GotSecret()
1508
 
            
 
2381
 
1509
2382
            finally:
1510
2383
                if approval_required:
1511
2384
                    client.approvals_pending -= 1
1512
2385
                try:
1513
2386
                    session.bye()
1514
 
                except gnutls.errors.GNUTLSError as error:
1515
 
                    logger.warning("GnuTLS bye failed")
1516
 
    
 
2387
                except gnutls.Error as error:
 
2388
                    logger.warning("GnuTLS bye failed",
 
2389
                                   exc_info=error)
 
2390
 
1517
2391
    @staticmethod
1518
2392
    def peer_certificate(session):
1519
 
        "Return the peer's OpenPGP certificate as a bytestring"
1520
 
        # If not an OpenPGP certificate...
1521
 
        if (gnutls.library.functions
1522
 
            .gnutls_certificate_type_get(session._c_object)
1523
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1524
 
            # ...do the normal thing
1525
 
            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""
1526
2409
        list_size = ctypes.c_uint(1)
1527
 
        cert_list = (gnutls.library.functions
1528
 
                     .gnutls_certificate_get_peers
 
2410
        cert_list = (gnutls.certificate_get_peers
1529
2411
                     (session._c_object, ctypes.byref(list_size)))
1530
2412
        if not bool(cert_list) and list_size.value != 0:
1531
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1532
 
                                            " certificate")
 
2413
            raise gnutls.Error("error getting peer certificate")
1533
2414
        if list_size.value == 0:
1534
2415
            return None
1535
2416
        cert = cert_list[0]
1536
2417
        return ctypes.string_at(cert.data, cert.size)
1537
 
    
 
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
 
1538
2453
    @staticmethod
1539
2454
    def fingerprint(openpgp):
1540
2455
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1541
2456
        # New GnuTLS "datum" with the OpenPGP public key
1542
 
        datum = (gnutls.library.types
1543
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1544
 
                                             ctypes.POINTER
1545
 
                                             (ctypes.c_ubyte)),
1546
 
                                 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)))
1547
2461
        # New empty GnuTLS certificate
1548
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1549
 
        (gnutls.library.functions
1550
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2462
        crt = gnutls.openpgp_crt_t()
 
2463
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1551
2464
        # Import the OpenPGP public key into the certificate
1552
 
        (gnutls.library.functions
1553
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1554
 
                                    gnutls.library.constants
1555
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2465
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2466
                                  gnutls.OPENPGP_FMT_RAW)
1556
2467
        # Verify the self signature in the key
1557
2468
        crtverify = ctypes.c_uint()
1558
 
        (gnutls.library.functions
1559
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1560
 
                                         ctypes.byref(crtverify)))
 
2469
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2470
                                       ctypes.byref(crtverify))
1561
2471
        if crtverify.value != 0:
1562
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1563
 
            raise (gnutls.errors.CertificateSecurityError
1564
 
                   ("Verify failed"))
 
2472
            gnutls.openpgp_crt_deinit(crt)
 
2473
            raise gnutls.CertificateSecurityError(code
 
2474
                                                  =crtverify.value)
1565
2475
        # New buffer for the fingerprint
1566
2476
        buf = ctypes.create_string_buffer(20)
1567
2477
        buf_len = ctypes.c_size_t()
1568
2478
        # Get the fingerprint from the certificate into the buffer
1569
 
        (gnutls.library.functions
1570
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1571
 
                                             ctypes.byref(buf_len)))
 
2479
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2480
                                           ctypes.byref(buf_len))
1572
2481
        # Deinit the certificate
1573
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2482
        gnutls.openpgp_crt_deinit(crt)
1574
2483
        # Convert the buffer to a Python bytestring
1575
2484
        fpr = ctypes.string_at(buf, buf_len.value)
1576
2485
        # Convert the bytestring to hexadecimal notation
1577
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
2486
        hex_fpr = binascii.hexlify(fpr).upper()
1578
2487
        return hex_fpr
1579
2488
 
1580
2489
 
1581
2490
class MultiprocessingMixIn(object):
1582
2491
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2492
 
1583
2493
    def sub_process_main(self, request, address):
1584
2494
        try:
1585
2495
            self.finish_request(request, address)
1586
 
        except:
 
2496
        except Exception:
1587
2497
            self.handle_error(request, address)
1588
2498
        self.close_request(request)
1589
 
    
 
2499
 
1590
2500
    def process_request(self, request, address):
1591
2501
        """Start a new process to process the request."""
1592
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1593
 
                                       args = (request,
1594
 
                                               address))
 
2502
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2503
                                       args=(request, address))
1595
2504
        proc.start()
1596
2505
        return proc
1597
2506
 
1598
2507
 
1599
2508
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1600
2509
    """ adds a pipe to the MixIn """
 
2510
 
1601
2511
    def process_request(self, request, client_address):
1602
2512
        """Overrides and wraps the original process_request().
1603
 
        
 
2513
 
1604
2514
        This function creates a new pipe in self.pipe
1605
2515
        """
1606
2516
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1607
 
        
 
2517
 
1608
2518
        proc = MultiprocessingMixIn.process_request(self, request,
1609
2519
                                                    client_address)
1610
2520
        self.child_pipe.close()
1611
2521
        self.add_pipe(parent_pipe, proc)
1612
 
    
 
2522
 
1613
2523
    def add_pipe(self, parent_pipe, proc):
1614
2524
        """Dummy function; override as necessary"""
1615
 
        raise NotImplementedError
 
2525
        raise NotImplementedError()
1616
2526
 
1617
2527
 
1618
2528
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1619
2529
                     socketserver.TCPServer, object):
1620
2530
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1621
 
    
 
2531
 
1622
2532
    Attributes:
1623
2533
        enabled:        Boolean; whether this server is activated yet
1624
2534
        interface:      None or a network interface name (string)
1625
2535
        use_ipv6:       Boolean; to use IPv6 or not
1626
2536
    """
 
2537
 
1627
2538
    def __init__(self, server_address, RequestHandlerClass,
1628
 
                 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
        """
1629
2545
        self.interface = interface
1630
2546
        if use_ipv6:
1631
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.
1632
2575
        socketserver.TCPServer.__init__(self, server_address,
1633
2576
                                        RequestHandlerClass)
 
2577
 
1634
2578
    def server_bind(self):
1635
2579
        """This overrides the normal server_bind() function
1636
2580
        to bind to an interface if one was specified, and also NOT to
1637
2581
        bind to an address or port if they were not specified."""
 
2582
        global SO_BINDTODEVICE
1638
2583
        if self.interface is not None:
1639
2584
            if SO_BINDTODEVICE is None:
1640
 
                logger.error("SO_BINDTODEVICE does not exist;"
1641
 
                             " cannot bind to interface %s",
1642
 
                             self.interface)
1643
 
            else:
1644
 
                try:
1645
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1646
 
                                           SO_BINDTODEVICE,
1647
 
                                           str(self.interface
1648
 
                                               + '\0'))
1649
 
                except socket.error as error:
1650
 
                    if error[0] == errno.EPERM:
1651
 
                        logger.error("No permission to"
1652
 
                                     " bind to interface %s",
1653
 
                                     self.interface)
1654
 
                    elif error[0] == errno.ENOPROTOOPT:
1655
 
                        logger.error("SO_BINDTODEVICE not available;"
1656
 
                                     " cannot bind to interface %s",
1657
 
                                     self.interface)
1658
 
                    else:
1659
 
                        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
1660
2606
        # Only bind(2) the socket if we really need to.
1661
2607
        if self.server_address[0] or self.server_address[1]:
 
2608
            if self.server_address[1]:
 
2609
                self.allow_reuse_address = True
1662
2610
            if not self.server_address[0]:
1663
2611
                if self.address_family == socket.AF_INET6:
1664
 
                    any_address = "::" # in6addr_any
 
2612
                    any_address = "::"  # in6addr_any
1665
2613
                else:
1666
 
                    any_address = socket.INADDR_ANY
 
2614
                    any_address = "0.0.0.0"  # INADDR_ANY
1667
2615
                self.server_address = (any_address,
1668
2616
                                       self.server_address[1])
1669
2617
            elif not self.server_address[1]:
1670
 
                self.server_address = (self.server_address[0],
1671
 
                                       0)
 
2618
                self.server_address = (self.server_address[0], 0)
1672
2619
#                 if self.interface:
1673
2620
#                     self.server_address = (self.server_address[0],
1674
2621
#                                            0, # port
1680
2627
 
1681
2628
class MandosServer(IPv6_TCPServer):
1682
2629
    """Mandos server.
1683
 
    
 
2630
 
1684
2631
    Attributes:
1685
2632
        clients:        set of Client objects
1686
2633
        gnutls_priority GnuTLS priority string
1687
2634
        use_dbus:       Boolean; to emit D-Bus signals or not
1688
 
    
1689
 
    Assumes a gobject.MainLoop event loop.
 
2635
 
 
2636
    Assumes a GLib.MainLoop event loop.
1690
2637
    """
 
2638
 
1691
2639
    def __init__(self, server_address, RequestHandlerClass,
1692
 
                 interface=None, use_ipv6=True, clients=None,
1693
 
                 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):
1694
2646
        self.enabled = False
1695
2647
        self.clients = clients
1696
2648
        if self.clients is None:
1699
2651
        self.gnutls_priority = gnutls_priority
1700
2652
        IPv6_TCPServer.__init__(self, server_address,
1701
2653
                                RequestHandlerClass,
1702
 
                                interface = interface,
1703
 
                                use_ipv6 = use_ipv6)
 
2654
                                interface=interface,
 
2655
                                use_ipv6=use_ipv6,
 
2656
                                socketfd=socketfd)
 
2657
 
1704
2658
    def server_activate(self):
1705
2659
        if self.enabled:
1706
2660
            return socketserver.TCPServer.server_activate(self)
1707
 
    
 
2661
 
1708
2662
    def enable(self):
1709
2663
        self.enabled = True
1710
 
    
 
2664
 
1711
2665
    def add_pipe(self, parent_pipe, proc):
1712
2666
        # Call "handle_ipc" for both data and EOF events
1713
 
        gobject.io_add_watch(parent_pipe.fileno(),
1714
 
                             gobject.IO_IN | gobject.IO_HUP,
1715
 
                             functools.partial(self.handle_ipc,
1716
 
                                               parent_pipe =
1717
 
                                               parent_pipe,
1718
 
                                               proc = proc))
1719
 
    
1720
 
    def handle_ipc(self, source, condition, parent_pipe=None,
1721
 
                   proc = None, client_object=None):
1722
 
        condition_names = {
1723
 
            gobject.IO_IN: "IN",   # There is data to read.
1724
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1725
 
                                    # blocking).
1726
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1727
 
            gobject.IO_ERR: "ERR", # Error condition.
1728
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1729
 
                                    # broken, usually for pipes and
1730
 
                                    # sockets).
1731
 
            }
1732
 
        conditions_string = ' | '.join(name
1733
 
                                       for cond, name in
1734
 
                                       condition_names.iteritems()
1735
 
                                       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):
1736
2678
        # error, or the other end of multiprocessing.Pipe has closed
1737
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2679
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
1738
2680
            # Wait for other process to exit
1739
2681
            proc.join()
1740
2682
            return False
1741
 
        
 
2683
 
1742
2684
        # Read a request from the child
1743
2685
        request = parent_pipe.recv()
1744
2686
        command = request[0]
1745
 
        
 
2687
 
1746
2688
        if command == 'init':
1747
 
            fpr = request[1]
1748
 
            address = request[2]
1749
 
            
1750
 
            for c in self.clients.itervalues():
1751
 
                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:
1752
2700
                    client = c
1753
2701
                    break
1754
2702
            else:
1755
 
                logger.info("Client not found for fingerprint: %s, ad"
1756
 
                            "dress: %s", fpr, address)
 
2703
                logger.info("Client not found for key ID: %s, address"
 
2704
                            ": %s", key_id or fpr, address)
1757
2705
                if self.use_dbus:
1758
2706
                    # Emit D-Bus signal
1759
 
                    mandos_dbus_service.ClientNotFound(fpr,
 
2707
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
1760
2708
                                                       address[0])
1761
2709
                parent_pipe.send(False)
1762
2710
                return False
1763
 
            
1764
 
            gobject.io_add_watch(parent_pipe.fileno(),
1765
 
                                 gobject.IO_IN | gobject.IO_HUP,
1766
 
                                 functools.partial(self.handle_ipc,
1767
 
                                                   parent_pipe =
1768
 
                                                   parent_pipe,
1769
 
                                                   proc = proc,
1770
 
                                                   client_object =
1771
 
                                                   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))
1772
2719
            parent_pipe.send(True)
1773
2720
            # remove the old hook in favor of the new above hook on
1774
2721
            # same fileno
1777
2724
            funcname = request[1]
1778
2725
            args = request[2]
1779
2726
            kwargs = request[3]
1780
 
            
 
2727
 
1781
2728
            parent_pipe.send(('data', getattr(client_object,
1782
2729
                                              funcname)(*args,
1783
 
                                                         **kwargs)))
1784
 
        
 
2730
                                                        **kwargs)))
 
2731
 
1785
2732
        if command == 'getattr':
1786
2733
            attrname = request[1]
1787
 
            if callable(client_object.__getattribute__(attrname)):
1788
 
                parent_pipe.send(('function',))
 
2734
            if isinstance(client_object.__getattribute__(attrname),
 
2735
                          collections.Callable):
 
2736
                parent_pipe.send(('function', ))
1789
2737
            else:
1790
 
                parent_pipe.send(('data', client_object
1791
 
                                  .__getattribute__(attrname)))
1792
 
        
 
2738
                parent_pipe.send((
 
2739
                    'data', client_object.__getattribute__(attrname)))
 
2740
 
1793
2741
        if command == 'setattr':
1794
2742
            attrname = request[1]
1795
2743
            value = request[2]
1796
2744
            setattr(client_object, attrname, value)
1797
 
        
 
2745
 
1798
2746
        return True
1799
2747
 
1800
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
 
1801
2848
def string_to_delta(interval):
1802
2849
    """Parse a string and return a datetime.timedelta
1803
 
    
 
2850
 
1804
2851
    >>> string_to_delta('7d')
1805
2852
    datetime.timedelta(7)
1806
2853
    >>> string_to_delta('60s')
1814
2861
    >>> string_to_delta('5m 30s')
1815
2862
    datetime.timedelta(0, 330)
1816
2863
    """
 
2864
 
 
2865
    try:
 
2866
        return rfc3339_duration_to_delta(interval)
 
2867
    except ValueError:
 
2868
        pass
 
2869
 
1817
2870
    timevalue = datetime.timedelta(0)
1818
2871
    for s in interval.split():
1819
2872
        try:
1820
 
            suffix = unicode(s[-1])
 
2873
            suffix = s[-1]
1821
2874
            value = int(s[:-1])
1822
2875
            if suffix == "d":
1823
2876
                delta = datetime.timedelta(value)
1830
2883
            elif suffix == "w":
1831
2884
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1832
2885
            else:
1833
 
                raise ValueError("Unknown suffix %r" % suffix)
1834
 
        except (ValueError, IndexError) as e:
 
2886
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2887
        except IndexError as e:
1835
2888
            raise ValueError(*(e.args))
1836
2889
        timevalue += delta
1837
2890
    return timevalue
1838
2891
 
1839
2892
 
1840
 
def if_nametoindex(interface):
1841
 
    """Call the C function if_nametoindex(), or equivalent
1842
 
    
1843
 
    Note: This function cannot accept a unicode string."""
1844
 
    global if_nametoindex
1845
 
    try:
1846
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1847
 
                          (ctypes.util.find_library("c"))
1848
 
                          .if_nametoindex)
1849
 
    except (OSError, AttributeError):
1850
 
        logger.warning("Doing if_nametoindex the hard way")
1851
 
        def if_nametoindex(interface):
1852
 
            "Get an interface index the hard way, i.e. using fcntl()"
1853
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1854
 
            with contextlib.closing(socket.socket()) as s:
1855
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1856
 
                                    struct.pack(str("16s16x"),
1857
 
                                                interface))
1858
 
            interface_index = struct.unpack(str("I"),
1859
 
                                            ifreq[16:20])[0]
1860
 
            return interface_index
1861
 
    return if_nametoindex(interface)
1862
 
 
1863
 
 
1864
 
def daemon(nochdir = False, noclose = False):
 
2893
def daemon(nochdir=False, noclose=False):
1865
2894
    """See daemon(3).  Standard BSD Unix function.
1866
 
    
 
2895
 
1867
2896
    This should really exist as os.daemon, but it doesn't (yet)."""
1868
2897
    if os.fork():
1869
2898
        sys.exit()
1874
2903
        sys.exit()
1875
2904
    if not noclose:
1876
2905
        # Close all standard open file descriptors
1877
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2906
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1878
2907
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1879
2908
            raise OSError(errno.ENODEV,
1880
 
                          "%s not a character device"
1881
 
                          % os.path.devnull)
 
2909
                          "{} not a character device"
 
2910
                          .format(os.devnull))
1882
2911
        os.dup2(null, sys.stdin.fileno())
1883
2912
        os.dup2(null, sys.stdout.fileno())
1884
2913
        os.dup2(null, sys.stderr.fileno())
1887
2916
 
1888
2917
 
1889
2918
def main():
1890
 
    
 
2919
 
1891
2920
    ##################################################################
1892
2921
    # Parsing of options, both command line and config file
1893
 
    
 
2922
 
1894
2923
    parser = argparse.ArgumentParser()
1895
2924
    parser.add_argument("-v", "--version", action="version",
1896
 
                        version = "%%(prog)s %s" % version,
 
2925
                        version="%(prog)s {}".format(version),
1897
2926
                        help="show version number and exit")
1898
2927
    parser.add_argument("-i", "--interface", metavar="IF",
1899
2928
                        help="Bind to interface IF")
1905
2934
                        help="Run self-test")
1906
2935
    parser.add_argument("--debug", action="store_true",
1907
2936
                        help="Debug mode; run in foreground and log"
1908
 
                        " to terminal")
 
2937
                        " to terminal", default=None)
1909
2938
    parser.add_argument("--debuglevel", metavar="LEVEL",
1910
2939
                        help="Debug level for stdout output")
1911
2940
    parser.add_argument("--priority", help="GnuTLS"
1918
2947
                        " files")
1919
2948
    parser.add_argument("--no-dbus", action="store_false",
1920
2949
                        dest="use_dbus", help="Do not provide D-Bus"
1921
 
                        " system bus interface")
 
2950
                        " system bus interface", default=None)
1922
2951
    parser.add_argument("--no-ipv6", action="store_false",
1923
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2952
                        dest="use_ipv6", help="Do not use IPv6",
 
2953
                        default=None)
1924
2954
    parser.add_argument("--no-restore", action="store_false",
1925
 
                        dest="restore", help="Do not restore stored state",
1926
 
                        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)
1927
2967
 
1928
2968
    options = parser.parse_args()
1929
 
    
 
2969
 
1930
2970
    if options.check:
1931
2971
        import doctest
1932
 
        doctest.testmod()
1933
 
        sys.exit()
1934
 
    
 
2972
        fail_count, test_count = doctest.testmod()
 
2973
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2974
 
1935
2975
    # Default values for config file for server-global settings
1936
 
    server_defaults = { "interface": "",
1937
 
                        "address": "",
1938
 
                        "port": "",
1939
 
                        "debug": "False",
1940
 
                        "priority":
1941
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1942
 
                        "servicename": "Mandos",
1943
 
                        "use_dbus": "True",
1944
 
                        "use_ipv6": "True",
1945
 
                        "debuglevel": "",
1946
 
                        }
1947
 
    
 
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
 
1948
2999
    # Parse config file for server-global settings
1949
3000
    server_config = configparser.SafeConfigParser(server_defaults)
1950
3001
    del server_defaults
1951
 
    server_config.read(os.path.join(options.configdir,
1952
 
                                    "mandos.conf"))
 
3002
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
1953
3003
    # Convert the SafeConfigParser object to a dict
1954
3004
    server_settings = server_config.defaults()
1955
3005
    # Use the appropriate methods on the non-string config options
1956
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
3006
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
3007
                   "foreground", "zeroconf"):
1957
3008
        server_settings[option] = server_config.getboolean("DEFAULT",
1958
3009
                                                           option)
1959
3010
    if server_settings["port"]:
1960
3011
        server_settings["port"] = server_config.getint("DEFAULT",
1961
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"])
1962
3022
    del server_config
1963
 
    
 
3023
 
1964
3024
    # Override the settings from the config file with command line
1965
3025
    # options, if set.
1966
3026
    for option in ("interface", "address", "port", "debug",
1967
 
                   "priority", "servicename", "configdir",
1968
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore"):
 
3027
                   "priority", "servicename", "configdir", "use_dbus",
 
3028
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
3029
                   "socket", "foreground", "zeroconf"):
1969
3030
        value = getattr(options, option)
1970
3031
        if value is not None:
1971
3032
            server_settings[option] = value
1972
3033
    del options
1973
3034
    # Force all strings to be unicode
1974
3035
    for option in server_settings.keys():
1975
 
        if type(server_settings[option]) is str:
1976
 
            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
1977
3046
    # Now we have our good server settings in "server_settings"
1978
 
    
 
3047
 
1979
3048
    ##################################################################
1980
 
    
 
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
 
1981
3055
    # For convenience
1982
3056
    debug = server_settings["debug"]
1983
3057
    debuglevel = server_settings["debuglevel"]
1984
3058
    use_dbus = server_settings["use_dbus"]
1985
3059
    use_ipv6 = server_settings["use_ipv6"]
1986
 
    
 
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
 
1987
3074
    if server_settings["servicename"] != "Mandos":
1988
 
        syslogger.setFormatter(logging.Formatter
1989
 
                               ('Mandos (%s) [%%(process)d]:'
1990
 
                                ' %%(levelname)s: %%(message)s'
1991
 
                                % server_settings["servicename"]))
1992
 
    
 
3075
        syslogger.setFormatter(
 
3076
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3077
                              ' %(levelname)s: %(message)s'.format(
 
3078
                                  server_settings["servicename"])))
 
3079
 
1993
3080
    # Parse config file with clients
1994
 
    client_defaults = { "timeout": "5m",
1995
 
                        "extended_timeout": "15m",
1996
 
                        "interval": "2m",
1997
 
                        "checker": "fping -q -- %%(host)s",
1998
 
                        "host": "",
1999
 
                        "approval_delay": "0s",
2000
 
                        "approval_duration": "1s",
2001
 
                        }
2002
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
3081
    client_config = configparser.SafeConfigParser(Client
 
3082
                                                  .client_defaults)
2003
3083
    client_config.read(os.path.join(server_settings["configdir"],
2004
3084
                                    "clients.conf"))
2005
 
    
 
3085
 
2006
3086
    global mandos_dbus_service
2007
3087
    mandos_dbus_service = None
2008
 
    
2009
 
    tcp_server = MandosServer((server_settings["address"],
2010
 
                               server_settings["port"]),
2011
 
                              ClientHandler,
2012
 
                              interface=(server_settings["interface"]
2013
 
                                         or None),
2014
 
                              use_ipv6=use_ipv6,
2015
 
                              gnutls_priority=
2016
 
                              server_settings["priority"],
2017
 
                              use_dbus=use_dbus)
2018
 
    if not debug:
2019
 
        pidfilename = "/var/run/mandos.pid"
2020
 
        try:
2021
 
            pidfile = open(pidfilename, "w")
2022
 
        except IOError:
2023
 
            logger.error("Could not open file %r", pidfilename)
2024
 
    
2025
 
    try:
2026
 
        uid = pwd.getpwnam("_mandos").pw_uid
2027
 
        gid = pwd.getpwnam("_mandos").pw_gid
2028
 
    except KeyError:
2029
 
        try:
2030
 
            uid = pwd.getpwnam("mandos").pw_uid
2031
 
            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
2032
3118
        except KeyError:
2033
 
            try:
2034
 
                uid = pwd.getpwnam("nobody").pw_uid
2035
 
                gid = pwd.getpwnam("nobody").pw_gid
2036
 
            except KeyError:
2037
 
                uid = 65534
2038
 
                gid = 65534
 
3119
            continue
 
3120
    else:
 
3121
        uid = 65534
 
3122
        gid = 65534
2039
3123
    try:
2040
3124
        os.setgid(gid)
2041
3125
        os.setuid(uid)
 
3126
        if debug:
 
3127
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3128
                                                             gid))
2042
3129
    except OSError as error:
2043
 
        if error[0] != errno.EPERM:
2044
 
            raise error
2045
 
    
2046
 
    if not debug and not debuglevel:
2047
 
        logger.setLevel(logging.WARNING)
2048
 
    if debuglevel:
2049
 
        level = getattr(logging, debuglevel.upper())
2050
 
        logger.setLevel(level)
2051
 
    
 
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
 
2052
3135
    if debug:
2053
 
        logger.setLevel(logging.DEBUG)
2054
3136
        # Enable all possible GnuTLS debugging
2055
 
        
 
3137
 
2056
3138
        # "Use a log level over 10 to enable all debugging options."
2057
3139
        # - GnuTLS manual
2058
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
2059
 
        
2060
 
        @gnutls.library.types.gnutls_log_func
 
3140
        gnutls.global_set_log_level(11)
 
3141
 
 
3142
        @gnutls.log_func
2061
3143
        def debug_gnutls(level, string):
2062
3144
            logger.debug("GnuTLS: %s", string[:-1])
2063
 
        
2064
 
        (gnutls.library.functions
2065
 
         .gnutls_global_set_log_function(debug_gnutls))
2066
 
        
 
3145
 
 
3146
        gnutls.global_set_log_function(debug_gnutls)
 
3147
 
2067
3148
        # Redirect stdin so all checkers get /dev/null
2068
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
3149
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2069
3150
        os.dup2(null, sys.stdin.fileno())
2070
3151
        if null > 2:
2071
3152
            os.close(null)
2072
 
    else:
2073
 
        # No console logging
2074
 
        logger.removeHandler(console)
2075
 
    
 
3153
 
2076
3154
    # Need to fork before connecting to D-Bus
2077
 
    if not debug:
 
3155
    if not foreground:
2078
3156
        # Close all input and output, do double fork, etc.
2079
3157
        daemon()
2080
 
    
 
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
 
2081
3163
    global main_loop
2082
3164
    # From the Avahi example code
2083
 
    DBusGMainLoop(set_as_default=True )
2084
 
    main_loop = gobject.MainLoop()
 
3165
    DBusGMainLoop(set_as_default=True)
 
3166
    main_loop = GLib.MainLoop()
2085
3167
    bus = dbus.SystemBus()
2086
3168
    # End of Avahi example code
2087
3169
    if use_dbus:
2088
3170
        try:
2089
3171
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2090
 
                                            bus, do_not_queue=True)
2091
 
            old_bus_name = (dbus.service.BusName
2092
 
                            ("se.bsnet.fukt.Mandos", bus,
2093
 
                             do_not_queue=True))
2094
 
        except dbus.exceptions.NameExistsException as e:
2095
 
            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)
2096
3179
            use_dbus = False
2097
3180
            server_settings["use_dbus"] = False
2098
3181
            tcp_server.use_dbus = False
2099
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2100
 
    service = AvahiServiceToSyslog(name =
2101
 
                                   server_settings["servicename"],
2102
 
                                   servicetype = "_mandos._tcp",
2103
 
                                   protocol = protocol, bus = bus)
2104
 
    if server_settings["interface"]:
2105
 
        service.interface = (if_nametoindex
2106
 
                             (str(server_settings["interface"])))
2107
 
    
 
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
 
2108
3193
    global multiprocessing_manager
2109
3194
    multiprocessing_manager = multiprocessing.Manager()
2110
 
    
 
3195
 
2111
3196
    client_class = Client
2112
3197
    if use_dbus:
2113
 
        client_class = functools.partial(ClientDBusTransitional,
2114
 
                                         bus = bus)
2115
 
    
2116
 
    special_settings = {
2117
 
        # Some settings need to be accessd by special methods;
2118
 
        # booleans need .getboolean(), etc.  Here is a list of them:
2119
 
        "approved_by_default":
2120
 
            lambda section:
2121
 
            client_config.getboolean(section, "approved_by_default"),
2122
 
        }
2123
 
    # Construct a new dict of client settings of this form:
2124
 
    # { client_name: {setting_name: value, ...}, ...}
2125
 
    # with exceptions for any special settings as defined above
2126
 
    client_settings = dict((clientname,
2127
 
                           dict((setting,
2128
 
                                 (value if setting not in special_settings
2129
 
                                  else special_settings[setting](clientname)))
2130
 
                                for setting, value in client_config.items(clientname)))
2131
 
                          for clientname in client_config.sections())
2132
 
    
 
3198
        client_class = functools.partial(ClientDBus, bus=bus)
 
3199
 
 
3200
    client_settings = Client.config_parser(client_config)
2133
3201
    old_client_settings = {}
2134
 
    clients_data = []
2135
 
 
2136
 
    # 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.
2137
3213
    if server_settings["restore"]:
2138
3214
        try:
2139
3215
            with open(stored_state_path, "rb") as stored_state:
2140
 
                clients_data, old_client_settings = 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"))
2141
3265
            os.remove(stored_state_path)
2142
3266
        except IOError as e:
2143
 
            logger.warning("Could not load persistant state: {0}".format(e))
2144
 
            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)
2145
3273
                raise
2146
 
 
2147
 
    for client in clients_data:
2148
 
        client_name = client["name"]
2149
 
        
2150
 
        # Decide which value to use after restoring saved state.
2151
 
        # We have three different values: Old config file,
2152
 
        # new config file, and saved state.
2153
 
        # New config value takes precedence if it differs from old
2154
 
        # config value, otherwise use saved state.
2155
 
        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))
2156
3330
            try:
2157
 
                # For each value in new config, check if it differs
2158
 
                # from the old config value (Except for the "secret"
2159
 
                # attribute)
2160
 
                if name != "secret" and value != old_client_settings[client_name][name]:
2161
 
                    setattr(client, name, value)
2162
 
            except KeyError:
2163
 
                pass
2164
 
 
2165
 
        # Clients who has passed its expire date, can still be enabled if its
2166
 
        # last checker was sucessful. Clients who checkers failed before we
2167
 
        # stored it state is asumed to had failed checker during downtime.
2168
 
        if client["enabled"] and client["last_checked_ok"]:
2169
 
            if ((datetime.datetime.utcnow() - client["last_checked_ok"])
2170
 
                > client["interval"]):
2171
 
                if client["last_checker_status"] != 0:
2172
 
                    client["enabled"] = False
2173
 
                else:
2174
 
                    client["expires"] = datetime.datetime.utcnow() + client["timeout"]
2175
 
 
2176
 
        client["changedstate"] = (multiprocessing_manager
2177
 
                                  .Condition(multiprocessing_manager
2178
 
                                             .Lock()))
2179
 
        if use_dbus:
2180
 
            new_client = ClientDBusTransitional.__new__(ClientDBusTransitional)
2181
 
            tcp_server.clients[client_name] = new_client
2182
 
            new_client.bus = bus
2183
 
            for name, value in client.iteritems():
2184
 
                setattr(new_client, name, value)
2185
 
            client_object_name = unicode(client_name).translate(
2186
 
                {ord("."): ord("_"),
2187
 
                 ord("-"): ord("_")})
2188
 
            new_client.dbus_object_path = (dbus.ObjectPath
2189
 
                                     ("/clients/" + client_object_name))
2190
 
            DBusObjectWithProperties.__init__(new_client,
2191
 
                                              new_client.bus,
2192
 
                                              new_client.dbus_object_path)
2193
 
        else:
2194
 
            tcp_server.clients[client_name] = Client.__new__(Client)
2195
 
            for name, value in client.iteritems():
2196
 
                setattr(tcp_server.clients[client_name], name, value)
2197
 
                
2198
 
        tcp_server.clients[client_name].decrypt_secret(
2199
 
            client_settings[client_name]["secret"])            
2200
 
        
2201
 
    # Create/remove clients based on new changes made to config
2202
 
    for clientname in set(old_client_settings) - set(client_settings):
2203
 
        del tcp_server.clients[clientname]
2204
 
    for clientname in set(client_settings) - set(old_client_settings):
2205
 
        tcp_server.clients[clientname] = (client_class(name = clientname,
2206
 
                                                       config =
2207
 
                                                       client_settings
2208
 
                                                       [clientname]))
2209
 
    
 
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)
2210
3355
 
2211
3356
    if not tcp_server.clients:
2212
3357
        logger.warning("No clients defined")
2213
 
        
2214
 
    if not debug:
2215
 
        try:
2216
 
            with pidfile:
2217
 
                pid = os.getpid()
2218
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2219
 
            del pidfile
2220
 
        except IOError:
2221
 
            logger.error("Could not write to file %r with PID %d",
2222
 
                         pidfilename, pid)
2223
 
        except NameError:
2224
 
            # "pidfile" was never created
2225
 
            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
2226
3369
        del pidfilename
2227
 
        
2228
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2229
 
    
2230
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2231
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2232
 
    
 
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
 
2233
3375
    if use_dbus:
2234
 
        class MandosDBusService(dbus.service.Object):
 
3376
 
 
3377
        @alternate_dbus_interfaces(
 
3378
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3379
        class MandosDBusService(DBusObjectWithObjectManager):
2235
3380
            """A D-Bus proxy object"""
 
3381
 
2236
3382
            def __init__(self):
2237
3383
                dbus.service.Object.__init__(self, bus, "/")
 
3384
 
2238
3385
            _interface = "se.recompile.Mandos"
2239
 
            
 
3386
 
2240
3387
            @dbus.service.signal(_interface, signature="o")
2241
3388
            def ClientAdded(self, objpath):
2242
3389
                "D-Bus signal"
2243
3390
                pass
2244
 
            
 
3391
 
2245
3392
            @dbus.service.signal(_interface, signature="ss")
2246
 
            def ClientNotFound(self, fingerprint, address):
 
3393
            def ClientNotFound(self, key_id, address):
2247
3394
                "D-Bus signal"
2248
3395
                pass
2249
 
            
 
3396
 
 
3397
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3398
                               "true"})
2250
3399
            @dbus.service.signal(_interface, signature="os")
2251
3400
            def ClientRemoved(self, objpath, name):
2252
3401
                "D-Bus signal"
2253
3402
                pass
2254
 
            
 
3403
 
 
3404
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3405
                               "true"})
2255
3406
            @dbus.service.method(_interface, out_signature="ao")
2256
3407
            def GetAllClients(self):
2257
3408
                "D-Bus method"
2258
 
                return dbus.Array(c.dbus_object_path
2259
 
                                  for c in
2260
 
                                  tcp_server.clients.itervalues())
2261
 
            
 
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"})
2262
3414
            @dbus.service.method(_interface,
2263
3415
                                 out_signature="a{oa{sv}}")
2264
3416
            def GetAllClientsWithProperties(self):
2265
3417
                "D-Bus method"
2266
3418
                return dbus.Dictionary(
2267
 
                    ((c.dbus_object_path, c.GetAll(""))
2268
 
                     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()},
2269
3422
                    signature="oa{sv}")
2270
 
            
 
3423
 
2271
3424
            @dbus.service.method(_interface, in_signature="o")
2272
3425
            def RemoveClient(self, object_path):
2273
3426
                "D-Bus method"
2274
 
                for c in tcp_server.clients.itervalues():
 
3427
                for c in tcp_server.clients.values():
2275
3428
                    if c.dbus_object_path == object_path:
2276
3429
                        del tcp_server.clients[c.name]
2277
3430
                        c.remove_from_connection()
2278
 
                        # Don't signal anything except ClientRemoved
 
3431
                        # Don't signal the disabling
2279
3432
                        c.disable(quiet=True)
2280
 
                        # Emit D-Bus signal
2281
 
                        self.ClientRemoved(object_path, c.name)
 
3433
                        # Emit D-Bus signal for removal
 
3434
                        self.client_removed_signal(c)
2282
3435
                        return
2283
3436
                raise KeyError(object_path)
2284
 
            
 
3437
 
2285
3438
            del _interface
2286
 
        
2287
 
        class MandosDBusServiceTransitional(MandosDBusService):
2288
 
            __metaclass__ = AlternateDBusNamesMetaclass
2289
 
        mandos_dbus_service = MandosDBusServiceTransitional()
2290
 
    
 
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
 
2291
3483
    def cleanup():
2292
3484
        "Cleanup function; run on exit"
2293
 
        service.cleanup()
2294
 
        
2295
 
        multiprocessing.active_children()
 
3485
        if zeroconf:
 
3486
            service.cleanup()
 
3487
 
 
3488
        mp.active_children()
 
3489
        wn.close()
2296
3490
        if not (tcp_server.clients or client_settings):
2297
3491
            return
2298
3492
 
2299
 
        # Store client before exiting. Secrets are encrypted with key based
2300
 
        # on what config file has. If config file is removed/edited, old
2301
 
        # secret will thus be unrecovable.
2302
 
        clients = []
2303
 
        for client in tcp_server.clients.itervalues():
2304
 
            client.encrypt_secret(client_settings[client.name]["secret"])
2305
 
 
2306
 
            client_dict = {}
2307
 
 
2308
 
            # A list of attributes that will not be stored when shuting down.
2309
 
            exclude = set(("bus", "changedstate", "secret"))            
2310
 
            for name, typ in inspect.getmembers(dbus.service.Object):
2311
 
                exclude.add(name)
2312
 
                
2313
 
            client_dict["encrypted_secret"] = client.encrypted_secret
2314
 
            for attr in client.client_structure:
2315
 
                if attr not in exclude:
2316
 
                    client_dict[attr] = getattr(client, attr)
2317
 
 
2318
 
            clients.append(client_dict) 
2319
 
            del client_settings[client.name]["secret"]
2320
 
            
 
3493
        # Store client before exiting. Secrets are encrypted with key
 
3494
        # based on what config file has. If config file is
 
3495
        # removed/edited, old secret will thus be unrecovable.
 
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
 
2321
3521
        try:
2322
 
            with os.fdopen(os.open(stored_state_path, os.O_CREAT|os.O_WRONLY|os.O_TRUNC, 0600), "wb") as stored_state:
2323
 
                pickle.dump((clients, client_settings), stored_state)
2324
 
        except IOError as e:
2325
 
            logger.warning("Could not save persistant state: {0}".format(e))
2326
 
            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)
2327
3544
                raise
2328
3545
 
2329
3546
        # Delete all clients, and settings from config
2331
3548
            name, client = tcp_server.clients.popitem()
2332
3549
            if use_dbus:
2333
3550
                client.remove_from_connection()
2334
 
            # Don't signal anything except ClientRemoved
 
3551
            # Don't signal the disabling
2335
3552
            client.disable(quiet=True)
 
3553
            # Emit D-Bus signal for removal
2336
3554
            if use_dbus:
2337
 
                # Emit D-Bus signal
2338
 
                mandos_dbus_service.ClientRemoved(client
2339
 
                                                  .dbus_object_path,
2340
 
                                                  client.name)
 
3555
                mandos_dbus_service.client_removed_signal(client)
2341
3556
        client_settings.clear()
2342
 
    
 
3557
 
2343
3558
    atexit.register(cleanup)
2344
 
    
2345
 
    for client in tcp_server.clients.itervalues():
 
3559
 
 
3560
    for client in tcp_server.clients.values():
2346
3561
        if use_dbus:
2347
 
            # Emit D-Bus signal
2348
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3562
            # Emit D-Bus signal for adding
 
3563
            mandos_dbus_service.client_added_signal(client)
2349
3564
        # Need to initiate checking of clients
2350
3565
        if client.enabled:
2351
3566
            client.init_checker()
2352
3567
 
2353
 
    
2354
3568
    tcp_server.enable()
2355
3569
    tcp_server.server_activate()
2356
 
    
 
3570
 
2357
3571
    # Find out what port we got
2358
 
    service.port = tcp_server.socket.getsockname()[1]
 
3572
    if zeroconf:
 
3573
        service.port = tcp_server.socket.getsockname()[1]
2359
3574
    if use_ipv6:
2360
3575
        logger.info("Now listening on address %r, port %d,"
2361
 
                    " flowinfo %d, scope_id %d"
2362
 
                    % tcp_server.socket.getsockname())
 
3576
                    " flowinfo %d, scope_id %d",
 
3577
                    *tcp_server.socket.getsockname())
2363
3578
    else:                       # IPv4
2364
 
        logger.info("Now listening on address %r, port %d"
2365
 
                    % tcp_server.socket.getsockname())
2366
 
    
2367
 
    #service.interface = tcp_server.socket.getsockname()[3]
2368
 
    
 
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
 
2369
3584
    try:
2370
 
        # From the Avahi example code
2371
 
        try:
2372
 
            service.activate()
2373
 
        except dbus.exceptions.DBusException as error:
2374
 
            logger.critical("DBusException: %s", error)
2375
 
            cleanup()
2376
 
            sys.exit(1)
2377
 
        # End of Avahi example code
2378
 
        
2379
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2380
 
                             lambda *args, **kwargs:
2381
 
                             (tcp_server.handle_request
2382
 
                              (*args[2:], **kwargs) or True))
2383
 
        
 
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
 
2384
3600
        logger.debug("Starting main loop")
2385
3601
        main_loop.run()
2386
3602
    except AvahiError as error:
2387
 
        logger.critical("AvahiError: %s", error)
 
3603
        logger.critical("Avahi Error", exc_info=error)
2388
3604
        cleanup()
2389
3605
        sys.exit(1)
2390
3606
    except KeyboardInterrupt: