/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Björn Påhlsson
  • Date: 2011-11-09 11:16:17 UTC
  • mto: (237.14.5 persistent-state-gpgme)
  • mto: This revision was merged to the branch mainline in revision 290.
  • Revision ID: belorn@fukt.bsnet.se-20111109111617-jpey2sy4dupqzabc
Persistent state: New feature. Client state is now stored when mandos
                  server exits, and restored when starting up. Secrets
                  are encrypted with key based on clients config file.
--no-restore: New argument to mandos server. Disables restore
              functionallity
minor changes: clients are now dicts!

Show diffs side-by-side

added added

removed removed

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