/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2010-09-12 03:00:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

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