/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

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

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

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

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

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

Show diffs side-by-side

added added

removed removed

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