/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-07-03 03:32:28 UTC
  • Revision ID: teddy@recompile.se-20160703033228-cafpnnfs53kdg52g
Change all http:// URLs to https:// wherever possible.

* INSTALL (Prerequisites/Libraries/Mandos Server): Change "http://" to
  "https://" wherever possible.
* Makefile (FORTIFY): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.c (main): - '' -
* plugins.d/mandos-client.c (start_mandos_communication): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -

Show diffs side-by-side

added added

removed removed

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