/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

Changed ForkingMixIn in favor of multiprocessing
Added approval functionallity

Show diffs side-by-side

added added

removed removed

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