/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-25 23:52:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100925235217-4hhqfryz1ste6uw3
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
                                to "_" in D-Bus object paths.
  (MandosServer.handle_ipc): Bug fix: Send only address string to
                             D-Bus signal, not whole tuple.

* mandos-ctl: New options "--approve-by-default", "--deny-by-default",
              "--approval-delay", and "--approval-duration".
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new options.

* mandos-monitor (MandosClientWidget.update): Fix spelling.

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