/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 server.py

  • Committer: Teddy Hogeborn
  • Date: 2008-07-29 03:35:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080729033539-08zecoj3jwlkpjhw
* server.conf: New file.

* mandos-clients.conf: Renamed to clients.conf.

* Makefile (FORTIFY): New.
  (CFLAGS): Include $(FORTIFY).

* plugins.d/mandosclient.c (main): New "if_index" variable.  Bug fix:
                                   check if interface exists.  New
                                   "--connect" option.

* server.py (serviceInterface): Removed; replaced by
                                "AvahiService.interface".  All users
                                changed.
  (AvahiError, AvahiServiceError, AvahiGroupError): New exception
                                                    classes.
  (AvahiService): New class.
  (serviceName): Removed; replaced by "AvahiService.name".  All users
                 changed.
  (serviceType): Removed; replaced by "AvahiService.type".  All users
                 changed.
  (servicePort): Removed; replaced by "AvahiService.port".  All users
                 changed.
  (serviceTXT): Removed; replaced by "AvahiService.TXT".  All users
                changed.
  (domain): Removed; replaced by "AvahiService.domain".  All users
            changed.
  (host): Removed; replaced by "AvahiService.host".  All users
          changed.
  (rename_count): Removed; replaced by "AvahiService.rename_count" and
                 "AvahiService.max_renames".  All users changed.
  (Client.__init__): If no secret or secfile, raise TypeError instead
                     of RuntimeError.
  (Client.last_seen): Renamed to "Client.last_checked_ok".  All users
                      changed.
  (Client.stop, Client.stop_checker): Use "getattr" with default value
                                      instead of "hasattr".
  (Client.still_valid): Removed "now" argument.
  (Client.handle): Separate the "no client found" and "client invalid"
                   cases for clearer code.
  (IPv6_TCPServer.__init__): "options" argument replaced by
                             "settings".  All callers changed.
  (IPv6_TCPServer.options): Replaced by "IPv6_TCPServer.settings".
                            All users changed.
  (IPv6_TCPServer.server_bind): Use getattr instead of hasattr.
  (add_service): Removed; replaced by "AvahiService.add".  All callers
                 changed.
  (remove_service): Removed; replaced by "AvahiService.remove".  All
                    callers changed.
  (entry_group_state_changed): On entry group collision, call the new
                               AvahiService.rename method.  Raise
                               AvahiGroupError on group error.
  (if_nametoindex): Use ctypes.utils.find_library to locate the C
                    library.  Cache the result.  Loop on EINTR.
  (daemon): Use os.path.devnull to locate "/dev/null".
  (killme): Removed.  All callers changed to do "sys.exit()" instead,
            except where stated otherwise.
  (main): Removed "exitstatus".  Removed all default values from all
          non-bool options.  New option "--configdir".  New variables
          "server_defaults" and "server_settings", read from
          "%(configdir)s/server.conf".  Let any supplied command line
          options override server settings.   Variable "defaults"
          renamed to "client_defaults", which is read from
          "clients.conf" instead of "mandos-clients.conf".  New global
          AvahiService object "service" replaces old global variables.
          Catch AvahiError and exit with error if caught.

Show diffs side-by-side

added added

removed removed

Lines of Context:
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
 
# methods "add", "remove", "server_state_changed",
10
 
# "entry_group_state_changed", "cleanup", and "activate" in the
11
 
# "AvahiService" class, and some lines in "main".
 
9
# following functions: "AvahiService.add", "AvahiService.remove",
 
10
# "server_state_changed", "entry_group_state_changed", and some lines
 
11
# in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2011 Teddy Hogeborn
15
 
# Copyright © 2008-2011 Björn Påhlsson
 
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
16
15
17
16
# This program is free software: you can redistribute it and/or modify
18
17
# it under the terms of the GNU General Public License as published by
25
24
#     GNU General Public License for more details.
26
25
27
26
# You should have received a copy of the GNU General Public License
28
 
# along with this program.  If not, see
29
 
# <http://www.gnu.org/licenses/>.
30
 
31
 
# Contact the authors at <mandos@recompile.se>.
32
 
33
 
 
34
 
from __future__ import (division, absolute_import, print_function,
35
 
                        unicode_literals)
36
 
 
37
 
import SocketServer as socketserver
 
27
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
28
 
29
# Contact the authors at <mandos@fukt.bsnet.se>.
 
30
 
31
 
 
32
from __future__ import division
 
33
 
 
34
import SocketServer
38
35
import socket
39
 
import argparse
 
36
import select
 
37
from optparse import OptionParser
40
38
import datetime
41
39
import errno
42
40
import gnutls.crypto
45
43
import gnutls.library.functions
46
44
import gnutls.library.constants
47
45
import gnutls.library.types
48
 
import ConfigParser as configparser
 
46
import ConfigParser
49
47
import sys
50
48
import re
51
49
import os
52
50
import signal
 
51
from sets import Set
53
52
import subprocess
54
53
import atexit
55
54
import stat
56
55
import logging
57
56
import logging.handlers
58
 
import pwd
59
 
import contextlib
60
 
import struct
61
 
import fcntl
62
 
import functools
63
 
import cPickle as pickle
64
 
import multiprocessing
65
 
import types
66
 
import binascii
67
 
import tempfile
68
57
 
69
58
import dbus
70
 
import dbus.service
71
59
import gobject
72
60
import avahi
73
61
from dbus.mainloop.glib import DBusGMainLoop
74
62
import ctypes
75
 
import ctypes.util
76
 
import xml.dom.minidom
77
 
import inspect
78
 
import GnuPGInterface
79
 
 
80
 
try:
81
 
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
82
 
except AttributeError:
83
 
    try:
84
 
        from IN import SO_BINDTODEVICE
85
 
    except ImportError:
86
 
        SO_BINDTODEVICE = None
87
 
 
88
 
version = "1.4.1"
89
 
stored_state_file = "clients.pickle"
90
 
 
91
 
logger = logging.getLogger()
92
 
syslogger = (logging.handlers.SysLogHandler
93
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
 
              address = str("/dev/log")))
95
 
 
96
 
try:
97
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
98
 
                      (ctypes.util.find_library("c"))
99
 
                      .if_nametoindex)
100
 
except (OSError, AttributeError):
101
 
    def if_nametoindex(interface):
102
 
        "Get an interface index the hard way, i.e. using fcntl()"
103
 
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
104
 
        with contextlib.closing(socket.socket()) as s:
105
 
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
106
 
                                struct.pack(str("16s16x"),
107
 
                                            interface))
108
 
        interface_index = struct.unpack(str("I"),
109
 
                                        ifreq[16:20])[0]
110
 
        return interface_index
111
 
 
112
 
 
113
 
def initlogger(debug, level=logging.WARNING):
114
 
    """init logger and add loglevel"""
115
 
    
116
 
    syslogger.setFormatter(logging.Formatter
117
 
                           ('Mandos [%(process)d]: %(levelname)s:'
118
 
                            ' %(message)s'))
119
 
    logger.addHandler(syslogger)
120
 
    
121
 
    if debug:
122
 
        console = logging.StreamHandler()
123
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
124
 
                                               ' [%(process)d]:'
125
 
                                               ' %(levelname)s:'
126
 
                                               ' %(message)s'))
127
 
        logger.addHandler(console)
128
 
    logger.setLevel(level)
129
 
 
130
 
 
131
 
class PGPError(Exception):
132
 
    """Exception if encryption/decryption fails"""
133
 
    pass
134
 
 
135
 
 
136
 
class PGPEngine(object):
137
 
    """A simple class for OpenPGP symmetric encryption & decryption"""
138
 
    def __init__(self):
139
 
        self.gnupg = GnuPGInterface.GnuPG()
140
 
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
141
 
        self.gnupg = GnuPGInterface.GnuPG()
142
 
        self.gnupg.options.meta_interactive = False
143
 
        self.gnupg.options.homedir = self.tempdir
144
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
145
 
                                              '--quiet'])
146
 
    
147
 
    def __enter__(self):
148
 
        return self
149
 
    
150
 
    def __exit__ (self, exc_type, exc_value, traceback):
151
 
        self._cleanup()
152
 
        return False
153
 
    
154
 
    def __del__(self):
155
 
        self._cleanup()
156
 
    
157
 
    def _cleanup(self):
158
 
        if self.tempdir is not None:
159
 
            # Delete contents of tempdir
160
 
            for root, dirs, files in os.walk(self.tempdir,
161
 
                                             topdown = False):
162
 
                for filename in files:
163
 
                    os.remove(os.path.join(root, filename))
164
 
                for dirname in dirs:
165
 
                    os.rmdir(os.path.join(root, dirname))
166
 
            # Remove tempdir
167
 
            os.rmdir(self.tempdir)
168
 
            self.tempdir = None
169
 
    
170
 
    def password_encode(self, password):
171
 
        # Passphrase can not be empty and can not contain newlines or
172
 
        # NUL bytes.  So we prefix it and hex encode it.
173
 
        return b"mandos" + binascii.hexlify(password)
174
 
    
175
 
    def encrypt(self, data, password):
176
 
        self.gnupg.passphrase = self.password_encode(password)
177
 
        with open(os.devnull) as devnull:
178
 
            try:
179
 
                proc = self.gnupg.run(['--symmetric'],
180
 
                                      create_fhs=['stdin', 'stdout'],
181
 
                                      attach_fhs={'stderr': devnull})
182
 
                with contextlib.closing(proc.handles['stdin']) as f:
183
 
                    f.write(data)
184
 
                with contextlib.closing(proc.handles['stdout']) as f:
185
 
                    ciphertext = f.read()
186
 
                proc.wait()
187
 
            except IOError as e:
188
 
                raise PGPError(e)
189
 
        self.gnupg.passphrase = None
190
 
        return ciphertext
191
 
    
192
 
    def decrypt(self, data, password):
193
 
        self.gnupg.passphrase = self.password_encode(password)
194
 
        with open(os.devnull) as devnull:
195
 
            try:
196
 
                proc = self.gnupg.run(['--decrypt'],
197
 
                                      create_fhs=['stdin', 'stdout'],
198
 
                                      attach_fhs={'stderr': devnull})
199
 
                with contextlib.closing(proc.handles['stdin'] ) as f:
200
 
                    f.write(data)
201
 
                with contextlib.closing(proc.handles['stdout']) as f:
202
 
                    decrypted_plaintext = f.read()
203
 
                proc.wait()
204
 
            except IOError as e:
205
 
                raise PGPError(e)
206
 
        self.gnupg.passphrase = None
207
 
        return decrypted_plaintext
208
 
 
 
63
 
 
64
# Brief description of the operation of this program:
 
65
 
66
# This server announces itself as a Zeroconf service.  Connecting
 
67
# clients use the TLS protocol, with the unusual quirk that this
 
68
# server program acts as a TLS "client" while a connecting client acts
 
69
# as a TLS "server".  The client (acting as a TLS "server") must
 
70
# supply an OpenPGP certificate, and the fingerprint of this
 
71
# certificate is used by this server to look up (in a list read from a
 
72
# file at start time) which binary blob to give the client.  No other
 
73
# authentication or authorization is done by this server.
 
74
 
 
75
 
 
76
logger = logging.Logger('mandos')
 
77
syslogger = logging.handlers.SysLogHandler\
 
78
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
 
79
syslogger.setFormatter(logging.Formatter\
 
80
                        ('%(levelname)s: %(message)s'))
 
81
logger.addHandler(syslogger)
 
82
del syslogger
209
83
 
210
84
 
211
85
class AvahiError(Exception):
212
 
    def __init__(self, value, *args, **kwargs):
 
86
    def __init__(self, value):
213
87
        self.value = value
214
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
215
 
    def __unicode__(self):
216
 
        return unicode(repr(self.value))
 
88
    def __str__(self):
 
89
        return repr(self.value)
217
90
 
218
91
class AvahiServiceError(AvahiError):
219
92
    pass
223
96
 
224
97
 
225
98
class AvahiService(object):
226
 
    """An Avahi (Zeroconf) service.
227
 
    
228
 
    Attributes:
 
99
    """
229
100
    interface: integer; avahi.IF_UNSPEC or an interface index.
230
101
               Used to optionally bind to the specified interface.
231
 
    name: string; Example: 'Mandos'
232
 
    type: string; Example: '_mandos._tcp'.
233
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
234
 
    port: integer; what port to announce
235
 
    TXT: list of strings; TXT record for the service
236
 
    domain: string; Domain to publish on, default to .local if empty.
237
 
    host: string; Host to publish records for, default is localhost
238
 
    max_renames: integer; maximum number of renames
239
 
    rename_count: integer; counter so we only rename after collisions
240
 
                  a sensible number of times
241
 
    group: D-Bus Entry Group
242
 
    server: D-Bus Server
243
 
    bus: dbus.SystemBus()
 
102
    name = string; Example: "Mandos"
 
103
    type = string; Example: "_mandos._tcp".
 
104
                   See <http://www.dns-sd.org/ServiceTypes.html>
 
105
    port = integer; what port to announce
 
106
    TXT = list of strings; TXT record for the service
 
107
    domain = string; Domain to publish on, default to .local if empty.
 
108
    host = string; Host to publish records for, default to localhost
 
109
                   if empty.
 
110
    max_renames = integer; maximum number of renames
 
111
    rename_count = integer; counter so we only rename after collisions
 
112
                   a sensible number of times
244
113
    """
245
114
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
246
 
                 servicetype = None, port = None, TXT = None,
247
 
                 domain = "", host = "", max_renames = 32768,
248
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
115
                 type = None, port = None, TXT = None, domain = "",
 
116
                 host = "", max_renames = 12):
 
117
        """An Avahi (Zeroconf) service. """
249
118
        self.interface = interface
250
119
        self.name = name
251
 
        self.type = servicetype
 
120
        self.type = type
252
121
        self.port = port
253
 
        self.TXT = TXT if TXT is not None else []
 
122
        if TXT is None:
 
123
            self.TXT = []
 
124
        else:
 
125
            self.TXT = TXT
254
126
        self.domain = domain
255
127
        self.host = host
256
128
        self.rename_count = 0
257
 
        self.max_renames = max_renames
258
 
        self.protocol = protocol
259
 
        self.group = None       # our entry group
260
 
        self.server = None
261
 
        self.bus = bus
262
 
        self.entry_group_state_changed_match = None
263
129
    def rename(self):
264
130
        """Derived from the Avahi example code"""
265
131
        if self.rename_count >= self.max_renames:
266
 
            logger.critical("No suitable Zeroconf service name found"
267
 
                            " after %i retries, exiting.",
268
 
                            self.rename_count)
 
132
            logger.critical(u"No suitable service name found after %i"
 
133
                            u" retries, exiting.", rename_count)
269
134
            raise AvahiServiceError("Too many renames")
270
 
        self.name = unicode(self.server
271
 
                            .GetAlternativeServiceName(self.name))
272
 
        logger.info("Changing Zeroconf service name to %r ...",
273
 
                    self.name)
 
135
        name = server.GetAlternativeServiceName(name)
 
136
        logger.notice(u"Changing name to %r ...", name)
274
137
        self.remove()
275
 
        try:
276
 
            self.add()
277
 
        except dbus.exceptions.DBusException as error:
278
 
            logger.critical("DBusException: %s", error)
279
 
            self.cleanup()
280
 
            os._exit(1)
 
138
        self.add()
281
139
        self.rename_count += 1
282
140
    def remove(self):
283
141
        """Derived from the Avahi example code"""
284
 
        if self.entry_group_state_changed_match is not None:
285
 
            self.entry_group_state_changed_match.remove()
286
 
            self.entry_group_state_changed_match = None
287
 
        if self.group is not None:
288
 
            self.group.Reset()
 
142
        if group is not None:
 
143
            group.Reset()
289
144
    def add(self):
290
145
        """Derived from the Avahi example code"""
291
 
        self.remove()
292
 
        if self.group is None:
293
 
            self.group = dbus.Interface(
294
 
                self.bus.get_object(avahi.DBUS_NAME,
295
 
                                    self.server.EntryGroupNew()),
296
 
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
297
 
        self.entry_group_state_changed_match = (
298
 
            self.group.connect_to_signal(
299
 
                'StateChanged', self.entry_group_state_changed))
300
 
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
301
 
                     self.name, self.type)
302
 
        self.group.AddService(
303
 
            self.interface,
304
 
            self.protocol,
305
 
            dbus.UInt32(0),     # flags
306
 
            self.name, self.type,
307
 
            self.domain, self.host,
308
 
            dbus.UInt16(self.port),
309
 
            avahi.string_array_to_txt_array(self.TXT))
310
 
        self.group.Commit()
311
 
    def entry_group_state_changed(self, state, error):
312
 
        """Derived from the Avahi example code"""
313
 
        logger.debug("Avahi entry group state change: %i", state)
314
 
        
315
 
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
316
 
            logger.debug("Zeroconf service established.")
317
 
        elif state == avahi.ENTRY_GROUP_COLLISION:
318
 
            logger.info("Zeroconf service name collision.")
319
 
            self.rename()
320
 
        elif state == avahi.ENTRY_GROUP_FAILURE:
321
 
            logger.critical("Avahi: Error in group state changed %s",
322
 
                            unicode(error))
323
 
            raise AvahiGroupError("State changed: %s"
324
 
                                  % unicode(error))
325
 
    def cleanup(self):
326
 
        """Derived from the Avahi example code"""
327
 
        if self.group is not None:
328
 
            try:
329
 
                self.group.Free()
330
 
            except (dbus.exceptions.UnknownMethodException,
331
 
                    dbus.exceptions.DBusException):
332
 
                pass
333
 
            self.group = None
334
 
        self.remove()
335
 
    def server_state_changed(self, state, error=None):
336
 
        """Derived from the Avahi example code"""
337
 
        logger.debug("Avahi server state change: %i", state)
338
 
        bad_states = { avahi.SERVER_INVALID:
339
 
                           "Zeroconf server invalid",
340
 
                       avahi.SERVER_REGISTERING: None,
341
 
                       avahi.SERVER_COLLISION:
342
 
                           "Zeroconf server name collision",
343
 
                       avahi.SERVER_FAILURE:
344
 
                           "Zeroconf server failure" }
345
 
        if state in bad_states:
346
 
            if bad_states[state] is not None:
347
 
                if error is None:
348
 
                    logger.error(bad_states[state])
349
 
                else:
350
 
                    logger.error(bad_states[state] + ": %r", error)
351
 
            self.cleanup()
352
 
        elif state == avahi.SERVER_RUNNING:
353
 
            self.add()
354
 
        else:
355
 
            if error is None:
356
 
                logger.debug("Unknown state: %r", state)
357
 
            else:
358
 
                logger.debug("Unknown state: %r: %r", state, error)
359
 
    def activate(self):
360
 
        """Derived from the Avahi example code"""
361
 
        if self.server is None:
362
 
            self.server = dbus.Interface(
363
 
                self.bus.get_object(avahi.DBUS_NAME,
364
 
                                    avahi.DBUS_PATH_SERVER,
365
 
                                    follow_name_owner_changes=True),
366
 
                avahi.DBUS_INTERFACE_SERVER)
367
 
        self.server.connect_to_signal("StateChanged",
368
 
                                 self.server_state_changed)
369
 
        self.server_state_changed(self.server.GetState())
370
 
 
371
 
class AvahiServiceToSyslog(AvahiService):
372
 
    def rename(self):
373
 
        """Add the new name to the syslog messages"""
374
 
        ret = AvahiService.rename(self)
375
 
        syslogger.setFormatter(logging.Formatter
376
 
                               ('Mandos (%s) [%%(process)d]:'
377
 
                                ' %%(levelname)s: %%(message)s'
378
 
                                % self.name))
379
 
        return ret
380
 
 
381
 
def timedelta_to_milliseconds(td):
382
 
    "Convert a datetime.timedelta() to milliseconds"
383
 
    return ((td.days * 24 * 60 * 60 * 1000)
384
 
            + (td.seconds * 1000)
385
 
            + (td.microseconds // 1000))
386
 
        
 
146
        global group
 
147
        if group is None:
 
148
            group = dbus.Interface\
 
149
                    (bus.get_object(avahi.DBUS_NAME,
 
150
                                    server.EntryGroupNew()),
 
151
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
152
            group.connect_to_signal('StateChanged',
 
153
                                    entry_group_state_changed)
 
154
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
155
                     service.name, service.type)
 
156
        group.AddService(
 
157
                self.interface,         # interface
 
158
                avahi.PROTO_INET6,      # protocol
 
159
                dbus.UInt32(0),         # flags
 
160
                self.name, self.type,
 
161
                self.domain, self.host,
 
162
                dbus.UInt16(self.port),
 
163
                avahi.string_array_to_txt_array(self.TXT))
 
164
        group.Commit()
 
165
 
 
166
# From the Avahi example code:
 
167
group = None                            # our entry group
 
168
# End of Avahi example code
 
169
 
 
170
 
387
171
class Client(object):
388
172
    """A representation of a client host served by this server.
389
 
    
390
173
    Attributes:
391
 
    approved:   bool(); 'None' if not yet approved/disapproved
392
 
    approval_delay: datetime.timedelta(); Time to wait for approval
393
 
    approval_duration: datetime.timedelta(); Duration of one approval
394
 
    checker:    subprocess.Popen(); a running checker process used
395
 
                                    to see if the client lives.
396
 
                                    'None' if no process is running.
397
 
    checker_callback_tag: a gobject event source tag, or None
398
 
    checker_command: string; External command which is run to check
399
 
                     if client lives.  %() expansions are done at
 
174
    name:      string; from the config file, used in log messages
 
175
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
176
                 uniquely identify the client
 
177
    secret:    bytestring; sent verbatim (over TLS) to client
 
178
    fqdn:      string (FQDN); available for use by the checker command
 
179
    created:   datetime.datetime(); object creation, not client host
 
180
    last_checked_ok: datetime.datetime() or None if not yet checked OK
 
181
    timeout:   datetime.timedelta(); How long from last_checked_ok
 
182
                                     until this client is invalid
 
183
    interval:  datetime.timedelta(); How often to start a new checker
 
184
    stop_hook: If set, called by stop() as stop_hook(self)
 
185
    checker:   subprocess.Popen(); a running checker process used
 
186
                                   to see if the client lives.
 
187
                                   'None' if no process is running.
 
188
    checker_initiator_tag: a gobject event source tag, or None
 
189
    stop_initiator_tag:    - '' -
 
190
    checker_callback_tag:  - '' -
 
191
    checker_command: string; External command which is run to check if
 
192
                     client lives.  %() expansions are done at
400
193
                     runtime with vars(self) as dict, so that for
401
194
                     instance %(name)s can be used in the command.
402
 
    checker_initiator_tag: a gobject event source tag, or None
403
 
    created:    datetime.datetime(); (UTC) object creation
404
 
    client_structure: Object describing what attributes a client has
405
 
                      and is used for storing the client at exit
406
 
    current_checker_command: string; current running checker_command
407
 
    disable_initiator_tag: a gobject event source tag, or None
408
 
    enabled:    bool()
409
 
    fingerprint: string (40 or 32 hexadecimal digits); used to
410
 
                 uniquely identify the client
411
 
    host:       string; available for use by the checker command
412
 
    interval:   datetime.timedelta(); How often to start a new checker
413
 
    last_approval_request: datetime.datetime(); (UTC) or None
414
 
    last_checked_ok: datetime.datetime(); (UTC) or None
415
 
    last_checker_status: integer between 0 and 255 reflecting exit
416
 
                         status of last checker. -1 reflects crashed
417
 
                         checker, or None.
418
 
    last_enabled: datetime.datetime(); (UTC) or None
419
 
    name:       string; from the config file, used in log messages and
420
 
                        D-Bus identifiers
421
 
    secret:     bytestring; sent verbatim (over TLS) to client
422
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
423
 
                                      until this client is disabled
424
 
    extended_timeout:   extra long timeout when password has been sent
425
 
    runtime_expansions: Allowed attributes for runtime expansion.
426
 
    expires:    datetime.datetime(); time (UTC) when a client will be
427
 
                disabled, or None
 
195
    Private attibutes:
 
196
    _timeout: Real variable for 'timeout'
 
197
    _interval: Real variable for 'interval'
 
198
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
199
    _interval_milliseconds: - '' -
428
200
    """
429
 
    
430
 
    runtime_expansions = ("approval_delay", "approval_duration",
431
 
                          "created", "enabled", "fingerprint",
432
 
                          "host", "interval", "last_checked_ok",
433
 
                          "last_enabled", "name", "timeout")
434
 
    client_defaults = { "timeout": "5m",
435
 
                        "extended_timeout": "15m",
436
 
                        "interval": "2m",
437
 
                        "checker": "fping -q -- %%(host)s",
438
 
                        "host": "",
439
 
                        "approval_delay": "0s",
440
 
                        "approval_duration": "1s",
441
 
                        "approved_by_default": "True",
442
 
                        "enabled": "True",
443
 
                        }
444
 
    
445
 
    def timeout_milliseconds(self):
446
 
        "Return the 'timeout' attribute in milliseconds"
447
 
        return timedelta_to_milliseconds(self.timeout)
448
 
    
449
 
    def extended_timeout_milliseconds(self):
450
 
        "Return the 'extended_timeout' attribute in milliseconds"
451
 
        return timedelta_to_milliseconds(self.extended_timeout)
452
 
    
453
 
    def interval_milliseconds(self):
454
 
        "Return the 'interval' attribute in milliseconds"
455
 
        return timedelta_to_milliseconds(self.interval)
456
 
    
457
 
    def approval_delay_milliseconds(self):
458
 
        return timedelta_to_milliseconds(self.approval_delay)
459
 
 
460
 
    @staticmethod
461
 
    def config_parser(config):
462
 
        """ Construct a new dict of client settings of this form:
463
 
        { client_name: {setting_name: value, ...}, ...}
464
 
        with exceptions for any special settings as defined above"""
465
 
        settings = {}
466
 
        for client_name in config.sections():
467
 
            section = dict(config.items(client_name))
468
 
            client = settings[client_name] = {}
469
 
            
470
 
            client["host"] = section["host"]
471
 
            # Reformat values from string types to Python types
472
 
            client["approved_by_default"] = config.getboolean(
473
 
                client_name, "approved_by_default")
474
 
            client["enabled"] = config.getboolean(client_name, "enabled")
475
 
            
476
 
            client["fingerprint"] = (section["fingerprint"].upper()
477
 
                                     .replace(" ", ""))
478
 
            if "secret" in section:
479
 
                client["secret"] = section["secret"].decode("base64")
480
 
            elif "secfile" in section:
481
 
                with open(os.path.expanduser(os.path.expandvars
482
 
                                             (section["secfile"])),
483
 
                          "rb") as secfile:
484
 
                    client["secret"] = secfile.read()
485
 
            else:
486
 
                raise TypeError("No secret or secfile for section %s"
487
 
                                % section)
488
 
            client["timeout"] = string_to_delta(section["timeout"])
489
 
            client["extended_timeout"] = string_to_delta(
490
 
                section["extended_timeout"])
491
 
            client["interval"] = string_to_delta(section["interval"])
492
 
            client["approval_delay"] = string_to_delta(
493
 
                section["approval_delay"])
494
 
            client["approval_duration"] = string_to_delta(
495
 
                section["approval_duration"])
496
 
            client["checker_command"] = section["checker"]
497
 
            client["last_approval_request"] = None
498
 
            client["last_checked_ok"] = None
499
 
            client["last_checker_status"] = None
500
 
            if client["enabled"]:
501
 
                client["last_enabled"] = datetime.datetime.utcnow()
502
 
                client["expires"] = (datetime.datetime.utcnow()
503
 
                                     + client["timeout"])
504
 
            else:
505
 
                client["last_enabled"] = None
506
 
                client["expires"] = None
507
 
 
508
 
        return settings
509
 
        
510
 
        
511
 
    def __init__(self, settings, name = None):
512
 
        """Note: the 'checker' key in 'config' sets the
513
 
        'checker_command' attribute and *not* the 'checker'
514
 
        attribute."""
 
201
    def _set_timeout(self, timeout):
 
202
        "Setter function for 'timeout' attribute"
 
203
        self._timeout = timeout
 
204
        self._timeout_milliseconds = ((self.timeout.days
 
205
                                       * 24 * 60 * 60 * 1000)
 
206
                                      + (self.timeout.seconds * 1000)
 
207
                                      + (self.timeout.microseconds
 
208
                                         // 1000))
 
209
    timeout = property(lambda self: self._timeout,
 
210
                       _set_timeout)
 
211
    del _set_timeout
 
212
    def _set_interval(self, interval):
 
213
        "Setter function for 'interval' attribute"
 
214
        self._interval = interval
 
215
        self._interval_milliseconds = ((self.interval.days
 
216
                                        * 24 * 60 * 60 * 1000)
 
217
                                       + (self.interval.seconds
 
218
                                          * 1000)
 
219
                                       + (self.interval.microseconds
 
220
                                          // 1000))
 
221
    interval = property(lambda self: self._interval,
 
222
                        _set_interval)
 
223
    del _set_interval
 
224
    def __init__(self, name=None, stop_hook=None, fingerprint=None,
 
225
                 secret=None, secfile=None, fqdn=None, timeout=None,
 
226
                 interval=-1, checker=None):
 
227
        """Note: the 'checker' argument sets the 'checker_command'
 
228
        attribute and not the 'checker' attribute.."""
515
229
        self.name = name
516
 
        # adding all client settings
517
 
        for setting, value in settings.iteritems():
518
 
            setattr(self, setting, value)
519
 
        
520
 
        logger.debug("Creating client %r", self.name)
521
 
        # Uppercase and remove spaces from fingerprint for later
522
 
        # comparison purposes with return value from the fingerprint()
523
 
        # function
524
 
        logger.debug("  Fingerprint: %s", self.fingerprint)
525
 
        self.created = settings.get("created", datetime.datetime.utcnow())
526
 
 
527
 
        # attributes specific for this server instance
 
230
        logger.debug(u"Creating client %r", self.name)
 
231
        # Uppercase and remove spaces from fingerprint
 
232
        # for later comparison purposes with return value of
 
233
        # the fingerprint() function
 
234
        self.fingerprint = fingerprint.upper().replace(u" ", u"")
 
235
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
 
236
        if secret:
 
237
            self.secret = secret.decode(u"base64")
 
238
        elif secfile:
 
239
            sf = open(secfile)
 
240
            self.secret = sf.read()
 
241
            sf.close()
 
242
        else:
 
243
            raise TypeError(u"No secret or secfile for client %s"
 
244
                            % self.name)
 
245
        self.fqdn = fqdn
 
246
        self.created = datetime.datetime.now()
 
247
        self.last_checked_ok = None
 
248
        self.timeout = string_to_delta(timeout)
 
249
        self.interval = string_to_delta(interval)
 
250
        self.stop_hook = stop_hook
528
251
        self.checker = None
529
252
        self.checker_initiator_tag = None
530
 
        self.disable_initiator_tag = None
 
253
        self.stop_initiator_tag = None
531
254
        self.checker_callback_tag = None
532
 
        self.current_checker_command = None
533
 
        self.approved = None
534
 
        self.approvals_pending = 0
535
 
        self.changedstate = (multiprocessing_manager
536
 
                             .Condition(multiprocessing_manager
537
 
                                        .Lock()))
538
 
        self.client_structure = [attr for attr in
539
 
                                 self.__dict__.iterkeys()
540
 
                                 if not attr.startswith("_")]
541
 
        self.client_structure.append("client_structure")
542
 
        
543
 
        for name, t in inspect.getmembers(type(self),
544
 
                                          lambda obj:
545
 
                                              isinstance(obj,
546
 
                                                         property)):
547
 
            if not name.startswith("_"):
548
 
                self.client_structure.append(name)
549
 
    
550
 
    # Send notice to process children that client state has changed
551
 
    def send_changedstate(self):
552
 
        with self.changedstate:
553
 
            self.changedstate.notify_all()
554
 
    
555
 
    def enable(self):
 
255
        self.check_command = checker
 
256
    def start(self):
556
257
        """Start this client's checker and timeout hooks"""
557
 
        if getattr(self, "enabled", False):
558
 
            # Already enabled
559
 
            return
560
 
        self.send_changedstate()
561
 
        self.expires = datetime.datetime.utcnow() + self.timeout
562
 
        self.enabled = True
563
 
        self.last_enabled = datetime.datetime.utcnow()
564
 
        self.init_checker()
565
 
    
566
 
    def disable(self, quiet=True):
567
 
        """Disable this client."""
568
 
        if not getattr(self, "enabled", False):
 
258
        # Schedule a new checker to be started an 'interval' from now,
 
259
        # and every interval from then on.
 
260
        self.checker_initiator_tag = gobject.timeout_add\
 
261
                                     (self._interval_milliseconds,
 
262
                                      self.start_checker)
 
263
        # Also start a new checker *right now*.
 
264
        self.start_checker()
 
265
        # Schedule a stop() when 'timeout' has passed
 
266
        self.stop_initiator_tag = gobject.timeout_add\
 
267
                                  (self._timeout_milliseconds,
 
268
                                   self.stop)
 
269
    def stop(self):
 
270
        """Stop this client.
 
271
        The possibility that a client might be restarted is left open,
 
272
        but not currently used."""
 
273
        # If this client doesn't have a secret, it is already stopped.
 
274
        if self.secret:
 
275
            logger.debug(u"Stopping client %s", self.name)
 
276
            self.secret = None
 
277
        else:
569
278
            return False
570
 
        if not quiet:
571
 
            self.send_changedstate()
572
 
        if not quiet:
573
 
            logger.info("Disabling client %s", self.name)
574
 
        if getattr(self, "disable_initiator_tag", False):
575
 
            gobject.source_remove(self.disable_initiator_tag)
576
 
            self.disable_initiator_tag = None
577
 
        self.expires = None
 
279
        if getattr(self, "stop_initiator_tag", False):
 
280
            gobject.source_remove(self.stop_initiator_tag)
 
281
            self.stop_initiator_tag = None
578
282
        if getattr(self, "checker_initiator_tag", False):
579
283
            gobject.source_remove(self.checker_initiator_tag)
580
284
            self.checker_initiator_tag = None
581
285
        self.stop_checker()
582
 
        self.enabled = False
 
286
        if self.stop_hook:
 
287
            self.stop_hook(self)
583
288
        # Do not run this again if called by a gobject.timeout_add
584
289
        return False
585
 
    
586
290
    def __del__(self):
587
 
        self.disable()
588
 
    
589
 
    def init_checker(self):
590
 
        # Schedule a new checker to be started an 'interval' from now,
591
 
        # and every interval from then on.
592
 
        self.checker_initiator_tag = (gobject.timeout_add
593
 
                                      (self.interval_milliseconds(),
594
 
                                       self.start_checker))
595
 
        # Schedule a disable() when 'timeout' has passed
596
 
        self.disable_initiator_tag = (gobject.timeout_add
597
 
                                   (self.timeout_milliseconds(),
598
 
                                    self.disable))
599
 
        # Also start a new checker *right now*.
600
 
        self.start_checker()
601
 
    
602
 
    def checker_callback(self, pid, condition, command):
 
291
        self.stop_hook = None
 
292
        self.stop()
 
293
    def checker_callback(self, pid, condition):
603
294
        """The checker has completed, so take appropriate actions."""
 
295
        now = datetime.datetime.now()
604
296
        self.checker_callback_tag = None
605
297
        self.checker = None
606
 
        if os.WIFEXITED(condition):
607
 
            self.last_checker_status = os.WEXITSTATUS(condition)
608
 
            if self.last_checker_status == 0:
609
 
                logger.info("Checker for %(name)s succeeded",
610
 
                            vars(self))
611
 
                self.checked_ok()
612
 
            else:
613
 
                logger.info("Checker for %(name)s failed",
614
 
                            vars(self))
615
 
        else:
616
 
            self.last_checker_status = -1
617
 
            logger.warning("Checker for %(name)s crashed?",
 
298
        if os.WIFEXITED(condition) \
 
299
               and (os.WEXITSTATUS(condition) == 0):
 
300
            logger.debug(u"Checker for %(name)s succeeded",
 
301
                         vars(self))
 
302
            self.last_checked_ok = now
 
303
            gobject.source_remove(self.stop_initiator_tag)
 
304
            self.stop_initiator_tag = gobject.timeout_add\
 
305
                                      (self._timeout_milliseconds,
 
306
                                       self.stop)
 
307
        elif not os.WIFEXITED(condition):
 
308
            logger.warning(u"Checker for %(name)s crashed?",
618
309
                           vars(self))
619
 
    
620
 
    def checked_ok(self, timeout=None):
621
 
        """Bump up the timeout for this client.
622
 
        
623
 
        This should only be called when the client has been seen,
624
 
        alive and well.
625
 
        """
626
 
        if timeout is None:
627
 
            timeout = self.timeout
628
 
        self.last_checked_ok = datetime.datetime.utcnow()
629
 
        if self.disable_initiator_tag is not None:
630
 
            gobject.source_remove(self.disable_initiator_tag)
631
 
        if getattr(self, "enabled", False):
632
 
            self.disable_initiator_tag = (gobject.timeout_add
633
 
                                          (timedelta_to_milliseconds
634
 
                                           (timeout), self.disable))
635
 
            self.expires = datetime.datetime.utcnow() + timeout
636
 
    
637
 
    def need_approval(self):
638
 
        self.last_approval_request = datetime.datetime.utcnow()
639
 
    
 
310
        else:
 
311
            logger.debug(u"Checker for %(name)s failed",
 
312
                         vars(self))
640
313
    def start_checker(self):
641
314
        """Start a new checker subprocess if one is not running.
642
 
        
643
315
        If a checker already exists, leave it running and do
644
316
        nothing."""
645
317
        # The reason for not killing a running checker is that if we
648
320
        # client would inevitably timeout, since no checker would get
649
321
        # a chance to run to completion.  If we instead leave running
650
322
        # checkers alone, the checker would have to take more time
651
 
        # than 'timeout' for the client to be disabled, which is as it
652
 
        # should be.
653
 
        
654
 
        # If a checker exists, make sure it is not a zombie
655
 
        try:
656
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
657
 
        except (AttributeError, OSError) as error:
658
 
            if (isinstance(error, OSError)
659
 
                and error.errno != errno.ECHILD):
660
 
                raise error
661
 
        else:
662
 
            if pid:
663
 
                logger.warning("Checker was a zombie")
664
 
                gobject.source_remove(self.checker_callback_tag)
665
 
                self.checker_callback(pid, status,
666
 
                                      self.current_checker_command)
667
 
        # Start a new checker if needed
 
323
        # than 'timeout' for the client to be declared invalid, which
 
324
        # is as it should be.
668
325
        if self.checker is None:
669
326
            try:
670
 
                # In case checker_command has exactly one % operator
671
 
                command = self.checker_command % self.host
 
327
                # In case check_command has exactly one % operator
 
328
                command = self.check_command % self.fqdn
672
329
            except TypeError:
673
330
                # Escape attributes for the shell
674
 
                escaped_attrs = dict(
675
 
                    (attr,
676
 
                     re.escape(unicode(str(getattr(self, attr, "")),
677
 
                                       errors=
678
 
                                       'replace')))
679
 
                    for attr in
680
 
                    self.runtime_expansions)
681
 
                
 
331
                escaped_attrs = dict((key, re.escape(str(val)))
 
332
                                     for key, val in
 
333
                                     vars(self).iteritems())
682
334
                try:
683
 
                    command = self.checker_command % escaped_attrs
684
 
                except TypeError as error:
685
 
                    logger.error('Could not format string "%s":'
686
 
                                 ' %s', self.checker_command, error)
 
335
                    command = self.check_command % escaped_attrs
 
336
                except TypeError, error:
 
337
                    logger.error(u'Could not format string "%s":'
 
338
                                 u' %s', self.check_command, error)
687
339
                    return True # Try again later
688
 
            self.current_checker_command = command
689
340
            try:
690
 
                logger.info("Starting checker %r for %s",
691
 
                            command, self.name)
692
 
                # We don't need to redirect stdout and stderr, since
693
 
                # in normal mode, that is already done by daemon(),
694
 
                # and in debug mode we don't want to.  (Stdin is
695
 
                # always replaced by /dev/null.)
 
341
                logger.debug(u"Starting checker %r for %s",
 
342
                             command, self.name)
696
343
                self.checker = subprocess.Popen(command,
697
344
                                                close_fds=True,
698
345
                                                shell=True, cwd="/")
699
 
                self.checker_callback_tag = (gobject.child_watch_add
700
 
                                             (self.checker.pid,
701
 
                                              self.checker_callback,
702
 
                                              data=command))
703
 
                # The checker may have completed before the gobject
704
 
                # watch was added.  Check for this.
705
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
706
 
                if pid:
707
 
                    gobject.source_remove(self.checker_callback_tag)
708
 
                    self.checker_callback(pid, status, command)
709
 
            except OSError as error:
710
 
                logger.error("Failed to start subprocess: %s",
 
346
                self.checker_callback_tag = gobject.child_watch_add\
 
347
                                            (self.checker.pid,
 
348
                                             self.checker_callback)
 
349
            except subprocess.OSError, error:
 
350
                logger.error(u"Failed to start subprocess: %s",
711
351
                             error)
712
352
        # Re-run this periodically if run by gobject.timeout_add
713
353
        return True
714
 
    
715
354
    def stop_checker(self):
716
355
        """Force the checker process, if any, to stop."""
717
356
        if self.checker_callback_tag:
722
361
        logger.debug("Stopping checker for %(name)s", vars(self))
723
362
        try:
724
363
            os.kill(self.checker.pid, signal.SIGTERM)
725
 
            #time.sleep(0.5)
 
364
            #os.sleep(0.5)
726
365
            #if self.checker.poll() is None:
727
366
            #    os.kill(self.checker.pid, signal.SIGKILL)
728
 
        except OSError as error:
 
367
        except OSError, error:
729
368
            if error.errno != errno.ESRCH: # No such process
730
369
                raise
731
370
        self.checker = None
732
 
 
733
 
 
734
 
def dbus_service_property(dbus_interface, signature="v",
735
 
                          access="readwrite", byte_arrays=False):
736
 
    """Decorators for marking methods of a DBusObjectWithProperties to
737
 
    become properties on the D-Bus.
738
 
    
739
 
    The decorated method will be called with no arguments by "Get"
740
 
    and with one argument by "Set".
741
 
    
742
 
    The parameters, where they are supported, are the same as
743
 
    dbus.service.method, except there is only "signature", since the
744
 
    type from Get() and the type sent to Set() is the same.
745
 
    """
746
 
    # Encoding deeply encoded byte arrays is not supported yet by the
747
 
    # "Set" method, so we fail early here:
748
 
    if byte_arrays and signature != "ay":
749
 
        raise ValueError("Byte arrays not supported for non-'ay'"
750
 
                         " signature %r" % signature)
751
 
    def decorator(func):
752
 
        func._dbus_is_property = True
753
 
        func._dbus_interface = dbus_interface
754
 
        func._dbus_signature = signature
755
 
        func._dbus_access = access
756
 
        func._dbus_name = func.__name__
757
 
        if func._dbus_name.endswith("_dbus_property"):
758
 
            func._dbus_name = func._dbus_name[:-14]
759
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
760
 
        return func
761
 
    return decorator
762
 
 
763
 
 
764
 
class DBusPropertyException(dbus.exceptions.DBusException):
765
 
    """A base class for D-Bus property-related exceptions
766
 
    """
767
 
    def __unicode__(self):
768
 
        return unicode(str(self))
769
 
 
770
 
 
771
 
class DBusPropertyAccessException(DBusPropertyException):
772
 
    """A property's access permissions disallows an operation.
773
 
    """
774
 
    pass
775
 
 
776
 
 
777
 
class DBusPropertyNotFound(DBusPropertyException):
778
 
    """An attempt was made to access a non-existing property.
779
 
    """
780
 
    pass
781
 
 
782
 
 
783
 
class DBusObjectWithProperties(dbus.service.Object):
784
 
    """A D-Bus object with properties.
785
 
    
786
 
    Classes inheriting from this can use the dbus_service_property
787
 
    decorator to expose methods as D-Bus properties.  It exposes the
788
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
789
 
    """
790
 
    
791
 
    @staticmethod
792
 
    def _is_dbus_property(obj):
793
 
        return getattr(obj, "_dbus_is_property", False)
794
 
    
795
 
    def _get_all_dbus_properties(self):
796
 
        """Returns a generator of (name, attribute) pairs
797
 
        """
798
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
799
 
                for cls in self.__class__.__mro__
800
 
                for name, prop in
801
 
                inspect.getmembers(cls, self._is_dbus_property))
802
 
    
803
 
    def _get_dbus_property(self, interface_name, property_name):
804
 
        """Returns a bound method if one exists which is a D-Bus
805
 
        property with the specified name and interface.
806
 
        """
807
 
        for cls in  self.__class__.__mro__:
808
 
            for name, value in (inspect.getmembers
809
 
                                (cls, self._is_dbus_property)):
810
 
                if (value._dbus_name == property_name
811
 
                    and value._dbus_interface == interface_name):
812
 
                    return value.__get__(self)
813
 
        
814
 
        # No such property
815
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
816
 
                                   + interface_name + "."
817
 
                                   + property_name)
818
 
    
819
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
820
 
                         out_signature="v")
821
 
    def Get(self, interface_name, property_name):
822
 
        """Standard D-Bus property Get() method, see D-Bus standard.
823
 
        """
824
 
        prop = self._get_dbus_property(interface_name, property_name)
825
 
        if prop._dbus_access == "write":
826
 
            raise DBusPropertyAccessException(property_name)
827
 
        value = prop()
828
 
        if not hasattr(value, "variant_level"):
829
 
            return value
830
 
        return type(value)(value, variant_level=value.variant_level+1)
831
 
    
832
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
833
 
    def Set(self, interface_name, property_name, value):
834
 
        """Standard D-Bus property Set() method, see D-Bus standard.
835
 
        """
836
 
        prop = self._get_dbus_property(interface_name, property_name)
837
 
        if prop._dbus_access == "read":
838
 
            raise DBusPropertyAccessException(property_name)
839
 
        if prop._dbus_get_args_options["byte_arrays"]:
840
 
            # The byte_arrays option is not supported yet on
841
 
            # signatures other than "ay".
842
 
            if prop._dbus_signature != "ay":
843
 
                raise ValueError
844
 
            value = dbus.ByteArray(''.join(unichr(byte)
845
 
                                           for byte in value))
846
 
        prop(value)
847
 
    
848
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
849
 
                         out_signature="a{sv}")
850
 
    def GetAll(self, interface_name):
851
 
        """Standard D-Bus property GetAll() method, see D-Bus
852
 
        standard.
853
 
        
854
 
        Note: Will not include properties with access="write".
855
 
        """
856
 
        properties = {}
857
 
        for name, prop in self._get_all_dbus_properties():
858
 
            if (interface_name
859
 
                and interface_name != prop._dbus_interface):
860
 
                # Interface non-empty but did not match
861
 
                continue
862
 
            # Ignore write-only properties
863
 
            if prop._dbus_access == "write":
864
 
                continue
865
 
            value = prop()
866
 
            if not hasattr(value, "variant_level"):
867
 
                properties[name] = value
868
 
                continue
869
 
            properties[name] = type(value)(value, variant_level=
870
 
                                           value.variant_level+1)
871
 
        return dbus.Dictionary(properties, signature="sv")
872
 
    
873
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
874
 
                         out_signature="s",
875
 
                         path_keyword='object_path',
876
 
                         connection_keyword='connection')
877
 
    def Introspect(self, object_path, connection):
878
 
        """Standard D-Bus method, overloaded to insert property tags.
879
 
        """
880
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
881
 
                                                   connection)
882
 
        try:
883
 
            document = xml.dom.minidom.parseString(xmlstring)
884
 
            def make_tag(document, name, prop):
885
 
                e = document.createElement("property")
886
 
                e.setAttribute("name", name)
887
 
                e.setAttribute("type", prop._dbus_signature)
888
 
                e.setAttribute("access", prop._dbus_access)
889
 
                return e
890
 
            for if_tag in document.getElementsByTagName("interface"):
891
 
                for tag in (make_tag(document, name, prop)
892
 
                            for name, prop
893
 
                            in self._get_all_dbus_properties()
894
 
                            if prop._dbus_interface
895
 
                            == if_tag.getAttribute("name")):
896
 
                    if_tag.appendChild(tag)
897
 
                # Add the names to the return values for the
898
 
                # "org.freedesktop.DBus.Properties" methods
899
 
                if (if_tag.getAttribute("name")
900
 
                    == "org.freedesktop.DBus.Properties"):
901
 
                    for cn in if_tag.getElementsByTagName("method"):
902
 
                        if cn.getAttribute("name") == "Get":
903
 
                            for arg in cn.getElementsByTagName("arg"):
904
 
                                if (arg.getAttribute("direction")
905
 
                                    == "out"):
906
 
                                    arg.setAttribute("name", "value")
907
 
                        elif cn.getAttribute("name") == "GetAll":
908
 
                            for arg in cn.getElementsByTagName("arg"):
909
 
                                if (arg.getAttribute("direction")
910
 
                                    == "out"):
911
 
                                    arg.setAttribute("name", "props")
912
 
            xmlstring = document.toxml("utf-8")
913
 
            document.unlink()
914
 
        except (AttributeError, xml.dom.DOMException,
915
 
                xml.parsers.expat.ExpatError) as error:
916
 
            logger.error("Failed to override Introspection method",
917
 
                         error)
918
 
        return xmlstring
919
 
 
920
 
 
921
 
def datetime_to_dbus (dt, variant_level=0):
922
 
    """Convert a UTC datetime.datetime() to a D-Bus type."""
923
 
    if dt is None:
924
 
        return dbus.String("", variant_level = variant_level)
925
 
    return dbus.String(dt.isoformat(),
926
 
                       variant_level=variant_level)
927
 
 
928
 
 
929
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
930
 
                                  .__metaclass__):
931
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
932
 
    will add additional D-Bus attributes matching a certain pattern.
933
 
    """
934
 
    def __new__(mcs, name, bases, attr):
935
 
        # Go through all the base classes which could have D-Bus
936
 
        # methods, signals, or properties in them
937
 
        for base in (b for b in bases
938
 
                     if issubclass(b, dbus.service.Object)):
939
 
            # Go though all attributes of the base class
940
 
            for attrname, attribute in inspect.getmembers(base):
941
 
                # Ignore non-D-Bus attributes, and D-Bus attributes
942
 
                # with the wrong interface name
943
 
                if (not hasattr(attribute, "_dbus_interface")
944
 
                    or not attribute._dbus_interface
945
 
                    .startswith("se.recompile.Mandos")):
946
 
                    continue
947
 
                # Create an alternate D-Bus interface name based on
948
 
                # the current name
949
 
                alt_interface = (attribute._dbus_interface
950
 
                                 .replace("se.recompile.Mandos",
951
 
                                          "se.bsnet.fukt.Mandos"))
952
 
                # Is this a D-Bus signal?
953
 
                if getattr(attribute, "_dbus_is_signal", False):
954
 
                    # Extract the original non-method function by
955
 
                    # black magic
956
 
                    nonmethod_func = (dict(
957
 
                            zip(attribute.func_code.co_freevars,
958
 
                                attribute.__closure__))["func"]
959
 
                                      .cell_contents)
960
 
                    # Create a new, but exactly alike, function
961
 
                    # object, and decorate it to be a new D-Bus signal
962
 
                    # with the alternate D-Bus interface name
963
 
                    new_function = (dbus.service.signal
964
 
                                    (alt_interface,
965
 
                                     attribute._dbus_signature)
966
 
                                    (types.FunctionType(
967
 
                                nonmethod_func.func_code,
968
 
                                nonmethod_func.func_globals,
969
 
                                nonmethod_func.func_name,
970
 
                                nonmethod_func.func_defaults,
971
 
                                nonmethod_func.func_closure)))
972
 
                    # Define a creator of a function to call both the
973
 
                    # old and new functions, so both the old and new
974
 
                    # signals gets sent when the function is called
975
 
                    def fixscope(func1, func2):
976
 
                        """This function is a scope container to pass
977
 
                        func1 and func2 to the "call_both" function
978
 
                        outside of its arguments"""
979
 
                        def call_both(*args, **kwargs):
980
 
                            """This function will emit two D-Bus
981
 
                            signals by calling func1 and func2"""
982
 
                            func1(*args, **kwargs)
983
 
                            func2(*args, **kwargs)
984
 
                        return call_both
985
 
                    # Create the "call_both" function and add it to
986
 
                    # the class
987
 
                    attr[attrname] = fixscope(attribute,
988
 
                                              new_function)
989
 
                # Is this a D-Bus method?
990
 
                elif getattr(attribute, "_dbus_is_method", False):
991
 
                    # Create a new, but exactly alike, function
992
 
                    # object.  Decorate it to be a new D-Bus method
993
 
                    # with the alternate D-Bus interface name.  Add it
994
 
                    # to the class.
995
 
                    attr[attrname] = (dbus.service.method
996
 
                                      (alt_interface,
997
 
                                       attribute._dbus_in_signature,
998
 
                                       attribute._dbus_out_signature)
999
 
                                      (types.FunctionType
1000
 
                                       (attribute.func_code,
1001
 
                                        attribute.func_globals,
1002
 
                                        attribute.func_name,
1003
 
                                        attribute.func_defaults,
1004
 
                                        attribute.func_closure)))
1005
 
                # Is this a D-Bus property?
1006
 
                elif getattr(attribute, "_dbus_is_property", False):
1007
 
                    # Create a new, but exactly alike, function
1008
 
                    # object, and decorate it to be a new D-Bus
1009
 
                    # property with the alternate D-Bus interface
1010
 
                    # name.  Add it to the class.
1011
 
                    attr[attrname] = (dbus_service_property
1012
 
                                      (alt_interface,
1013
 
                                       attribute._dbus_signature,
1014
 
                                       attribute._dbus_access,
1015
 
                                       attribute
1016
 
                                       ._dbus_get_args_options
1017
 
                                       ["byte_arrays"])
1018
 
                                      (types.FunctionType
1019
 
                                       (attribute.func_code,
1020
 
                                        attribute.func_globals,
1021
 
                                        attribute.func_name,
1022
 
                                        attribute.func_defaults,
1023
 
                                        attribute.func_closure)))
1024
 
        return type.__new__(mcs, name, bases, attr)
1025
 
 
1026
 
 
1027
 
class ClientDBus(Client, DBusObjectWithProperties):
1028
 
    """A Client class using D-Bus
1029
 
    
1030
 
    Attributes:
1031
 
    dbus_object_path: dbus.ObjectPath
1032
 
    bus: dbus.SystemBus()
1033
 
    """
1034
 
    
1035
 
    runtime_expansions = (Client.runtime_expansions
1036
 
                          + ("dbus_object_path",))
1037
 
    
1038
 
    # dbus.service.Object doesn't use super(), so we can't either.
1039
 
    
1040
 
    def __init__(self, bus = None, *args, **kwargs):
1041
 
        self.bus = bus
1042
 
        Client.__init__(self, *args, **kwargs)
1043
 
        self._approvals_pending = 0
1044
 
        
1045
 
        self._approvals_pending = 0
1046
 
        # Only now, when this client is initialized, can it show up on
1047
 
        # the D-Bus
1048
 
        client_object_name = unicode(self.name).translate(
1049
 
            {ord("."): ord("_"),
1050
 
             ord("-"): ord("_")})
1051
 
        self.dbus_object_path = (dbus.ObjectPath
1052
 
                                 ("/clients/" + client_object_name))
1053
 
        DBusObjectWithProperties.__init__(self, self.bus,
1054
 
                                          self.dbus_object_path)
1055
 
        
1056
 
    def notifychangeproperty(transform_func,
1057
 
                             dbus_name, type_func=lambda x: x,
1058
 
                             variant_level=1):
1059
 
        """ Modify a variable so that it's a property which announces
1060
 
        its changes to DBus.
1061
 
        
1062
 
        transform_fun: Function that takes a value and a variant_level
1063
 
                       and transforms it to a D-Bus type.
1064
 
        dbus_name: D-Bus name of the variable
1065
 
        type_func: Function that transform the value before sending it
1066
 
                   to the D-Bus.  Default: no transform
1067
 
        variant_level: D-Bus variant level.  Default: 1
1068
 
        """
1069
 
        attrname = "_{0}".format(dbus_name)
1070
 
        def setter(self, value):
1071
 
            if hasattr(self, "dbus_object_path"):
1072
 
                if (not hasattr(self, attrname) or
1073
 
                    type_func(getattr(self, attrname, None))
1074
 
                    != type_func(value)):
1075
 
                    dbus_value = transform_func(type_func(value),
1076
 
                                                variant_level
1077
 
                                                =variant_level)
1078
 
                    self.PropertyChanged(dbus.String(dbus_name),
1079
 
                                         dbus_value)
1080
 
            setattr(self, attrname, value)
1081
 
        
1082
 
        return property(lambda self: getattr(self, attrname), setter)
1083
 
    
1084
 
    
1085
 
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1086
 
    approvals_pending = notifychangeproperty(dbus.Boolean,
1087
 
                                             "ApprovalPending",
1088
 
                                             type_func = bool)
1089
 
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1090
 
    last_enabled = notifychangeproperty(datetime_to_dbus,
1091
 
                                        "LastEnabled")
1092
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1093
 
                                   type_func = lambda checker:
1094
 
                                       checker is not None)
1095
 
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1096
 
                                           "LastCheckedOK")
1097
 
    last_approval_request = notifychangeproperty(
1098
 
        datetime_to_dbus, "LastApprovalRequest")
1099
 
    approved_by_default = notifychangeproperty(dbus.Boolean,
1100
 
                                               "ApprovedByDefault")
1101
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1102
 
                                          "ApprovalDelay",
1103
 
                                          type_func =
1104
 
                                          timedelta_to_milliseconds)
1105
 
    approval_duration = notifychangeproperty(
1106
 
        dbus.UInt64, "ApprovalDuration",
1107
 
        type_func = timedelta_to_milliseconds)
1108
 
    host = notifychangeproperty(dbus.String, "Host")
1109
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1110
 
                                   type_func =
1111
 
                                   timedelta_to_milliseconds)
1112
 
    extended_timeout = notifychangeproperty(
1113
 
        dbus.UInt64, "ExtendedTimeout",
1114
 
        type_func = timedelta_to_milliseconds)
1115
 
    interval = notifychangeproperty(dbus.UInt64,
1116
 
                                    "Interval",
1117
 
                                    type_func =
1118
 
                                    timedelta_to_milliseconds)
1119
 
    checker_command = notifychangeproperty(dbus.String, "Checker")
1120
 
    
1121
 
    del notifychangeproperty
1122
 
    
1123
 
    def __del__(self, *args, **kwargs):
1124
 
        try:
1125
 
            self.remove_from_connection()
1126
 
        except LookupError:
1127
 
            pass
1128
 
        if hasattr(DBusObjectWithProperties, "__del__"):
1129
 
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1130
 
        Client.__del__(self, *args, **kwargs)
1131
 
    
1132
 
    def checker_callback(self, pid, condition, command,
1133
 
                         *args, **kwargs):
1134
 
        self.checker_callback_tag = None
1135
 
        self.checker = None
1136
 
        if os.WIFEXITED(condition):
1137
 
            exitstatus = os.WEXITSTATUS(condition)
1138
 
            # Emit D-Bus signal
1139
 
            self.CheckerCompleted(dbus.Int16(exitstatus),
1140
 
                                  dbus.Int64(condition),
1141
 
                                  dbus.String(command))
1142
 
        else:
1143
 
            # Emit D-Bus signal
1144
 
            self.CheckerCompleted(dbus.Int16(-1),
1145
 
                                  dbus.Int64(condition),
1146
 
                                  dbus.String(command))
1147
 
        
1148
 
        return Client.checker_callback(self, pid, condition, command,
1149
 
                                       *args, **kwargs)
1150
 
    
1151
 
    def start_checker(self, *args, **kwargs):
1152
 
        old_checker = self.checker
1153
 
        if self.checker is not None:
1154
 
            old_checker_pid = self.checker.pid
1155
 
        else:
1156
 
            old_checker_pid = None
1157
 
        r = Client.start_checker(self, *args, **kwargs)
1158
 
        # Only if new checker process was started
1159
 
        if (self.checker is not None
1160
 
            and old_checker_pid != self.checker.pid):
1161
 
            # Emit D-Bus signal
1162
 
            self.CheckerStarted(self.current_checker_command)
1163
 
        return r
1164
 
    
1165
 
    def _reset_approved(self):
1166
 
        self.approved = None
1167
 
        return False
1168
 
    
1169
 
    def approve(self, value=True):
1170
 
        self.send_changedstate()
1171
 
        self.approved = value
1172
 
        gobject.timeout_add(timedelta_to_milliseconds
1173
 
                            (self.approval_duration),
1174
 
                            self._reset_approved)
1175
 
    
1176
 
    
1177
 
    ## D-Bus methods, signals & properties
1178
 
    _interface = "se.recompile.Mandos.Client"
1179
 
    
1180
 
    ## Signals
1181
 
    
1182
 
    # CheckerCompleted - signal
1183
 
    @dbus.service.signal(_interface, signature="nxs")
1184
 
    def CheckerCompleted(self, exitcode, waitstatus, command):
1185
 
        "D-Bus signal"
1186
 
        pass
1187
 
    
1188
 
    # CheckerStarted - signal
1189
 
    @dbus.service.signal(_interface, signature="s")
1190
 
    def CheckerStarted(self, command):
1191
 
        "D-Bus signal"
1192
 
        pass
1193
 
    
1194
 
    # PropertyChanged - signal
1195
 
    @dbus.service.signal(_interface, signature="sv")
1196
 
    def PropertyChanged(self, property, value):
1197
 
        "D-Bus signal"
1198
 
        pass
1199
 
    
1200
 
    # GotSecret - signal
1201
 
    @dbus.service.signal(_interface)
1202
 
    def GotSecret(self):
1203
 
        """D-Bus signal
1204
 
        Is sent after a successful transfer of secret from the Mandos
1205
 
        server to mandos-client
1206
 
        """
1207
 
        pass
1208
 
    
1209
 
    # Rejected - signal
1210
 
    @dbus.service.signal(_interface, signature="s")
1211
 
    def Rejected(self, reason):
1212
 
        "D-Bus signal"
1213
 
        pass
1214
 
    
1215
 
    # NeedApproval - signal
1216
 
    @dbus.service.signal(_interface, signature="tb")
1217
 
    def NeedApproval(self, timeout, default):
1218
 
        "D-Bus signal"
1219
 
        return self.need_approval()
1220
 
    
1221
 
    # NeRwequest - signal
1222
 
    @dbus.service.signal(_interface, signature="s")
1223
 
    def NewRequest(self, ip):
1224
 
        """D-Bus signal
1225
 
        Is sent after a client request a password.
1226
 
        """
1227
 
        pass
1228
 
    
1229
 
    ## Methods
1230
 
    
1231
 
    # Approve - method
1232
 
    @dbus.service.method(_interface, in_signature="b")
1233
 
    def Approve(self, value):
1234
 
        self.approve(value)
1235
 
    
1236
 
    # CheckedOK - method
1237
 
    @dbus.service.method(_interface)
1238
 
    def CheckedOK(self):
1239
 
        self.checked_ok()
1240
 
    
1241
 
    # Enable - method
1242
 
    @dbus.service.method(_interface)
1243
 
    def Enable(self):
1244
 
        "D-Bus method"
1245
 
        self.enable()
1246
 
    
1247
 
    # StartChecker - method
1248
 
    @dbus.service.method(_interface)
1249
 
    def StartChecker(self):
1250
 
        "D-Bus method"
1251
 
        self.start_checker()
1252
 
    
1253
 
    # Disable - method
1254
 
    @dbus.service.method(_interface)
1255
 
    def Disable(self):
1256
 
        "D-Bus method"
1257
 
        self.disable()
1258
 
    
1259
 
    # StopChecker - method
1260
 
    @dbus.service.method(_interface)
1261
 
    def StopChecker(self):
1262
 
        self.stop_checker()
1263
 
    
1264
 
    ## Properties
1265
 
    
1266
 
    # ApprovalPending - property
1267
 
    @dbus_service_property(_interface, signature="b", access="read")
1268
 
    def ApprovalPending_dbus_property(self):
1269
 
        return dbus.Boolean(bool(self.approvals_pending))
1270
 
    
1271
 
    # ApprovedByDefault - property
1272
 
    @dbus_service_property(_interface, signature="b",
1273
 
                           access="readwrite")
1274
 
    def ApprovedByDefault_dbus_property(self, value=None):
1275
 
        if value is None:       # get
1276
 
            return dbus.Boolean(self.approved_by_default)
1277
 
        self.approved_by_default = bool(value)
1278
 
    
1279
 
    # ApprovalDelay - property
1280
 
    @dbus_service_property(_interface, signature="t",
1281
 
                           access="readwrite")
1282
 
    def ApprovalDelay_dbus_property(self, value=None):
1283
 
        if value is None:       # get
1284
 
            return dbus.UInt64(self.approval_delay_milliseconds())
1285
 
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1286
 
    
1287
 
    # ApprovalDuration - property
1288
 
    @dbus_service_property(_interface, signature="t",
1289
 
                           access="readwrite")
1290
 
    def ApprovalDuration_dbus_property(self, value=None):
1291
 
        if value is None:       # get
1292
 
            return dbus.UInt64(timedelta_to_milliseconds(
1293
 
                    self.approval_duration))
1294
 
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1295
 
    
1296
 
    # Name - property
1297
 
    @dbus_service_property(_interface, signature="s", access="read")
1298
 
    def Name_dbus_property(self):
1299
 
        return dbus.String(self.name)
1300
 
    
1301
 
    # Fingerprint - property
1302
 
    @dbus_service_property(_interface, signature="s", access="read")
1303
 
    def Fingerprint_dbus_property(self):
1304
 
        return dbus.String(self.fingerprint)
1305
 
    
1306
 
    # Host - property
1307
 
    @dbus_service_property(_interface, signature="s",
1308
 
                           access="readwrite")
1309
 
    def Host_dbus_property(self, value=None):
1310
 
        if value is None:       # get
1311
 
            return dbus.String(self.host)
1312
 
        self.host = unicode(value)
1313
 
    
1314
 
    # Created - property
1315
 
    @dbus_service_property(_interface, signature="s", access="read")
1316
 
    def Created_dbus_property(self):
1317
 
        return datetime_to_dbus(self.created)
1318
 
    
1319
 
    # LastEnabled - property
1320
 
    @dbus_service_property(_interface, signature="s", access="read")
1321
 
    def LastEnabled_dbus_property(self):
1322
 
        return datetime_to_dbus(self.last_enabled)
1323
 
    
1324
 
    # Enabled - property
1325
 
    @dbus_service_property(_interface, signature="b",
1326
 
                           access="readwrite")
1327
 
    def Enabled_dbus_property(self, value=None):
1328
 
        if value is None:       # get
1329
 
            return dbus.Boolean(self.enabled)
1330
 
        if value:
1331
 
            self.enable()
1332
 
        else:
1333
 
            self.disable()
1334
 
    
1335
 
    # LastCheckedOK - property
1336
 
    @dbus_service_property(_interface, signature="s",
1337
 
                           access="readwrite")
1338
 
    def LastCheckedOK_dbus_property(self, value=None):
1339
 
        if value is not None:
1340
 
            self.checked_ok()
1341
 
            return
1342
 
        return datetime_to_dbus(self.last_checked_ok)
1343
 
    
1344
 
    # Expires - property
1345
 
    @dbus_service_property(_interface, signature="s", access="read")
1346
 
    def Expires_dbus_property(self):
1347
 
        return datetime_to_dbus(self.expires)
1348
 
    
1349
 
    # LastApprovalRequest - property
1350
 
    @dbus_service_property(_interface, signature="s", access="read")
1351
 
    def LastApprovalRequest_dbus_property(self):
1352
 
        return datetime_to_dbus(self.last_approval_request)
1353
 
    
1354
 
    # Timeout - property
1355
 
    @dbus_service_property(_interface, signature="t",
1356
 
                           access="readwrite")
1357
 
    def Timeout_dbus_property(self, value=None):
1358
 
        if value is None:       # get
1359
 
            return dbus.UInt64(self.timeout_milliseconds())
1360
 
        self.timeout = datetime.timedelta(0, 0, 0, value)
1361
 
        if getattr(self, "disable_initiator_tag", None) is None:
1362
 
            return
1363
 
        # Reschedule timeout
1364
 
        gobject.source_remove(self.disable_initiator_tag)
1365
 
        self.disable_initiator_tag = None
1366
 
        self.expires = None
1367
 
        time_to_die = timedelta_to_milliseconds((self
1368
 
                                                 .last_checked_ok
1369
 
                                                 + self.timeout)
1370
 
                                                - datetime.datetime
1371
 
                                                .utcnow())
1372
 
        if time_to_die <= 0:
1373
 
            # The timeout has passed
1374
 
            self.disable()
1375
 
        else:
1376
 
            self.expires = (datetime.datetime.utcnow()
1377
 
                            + datetime.timedelta(milliseconds =
1378
 
                                                 time_to_die))
1379
 
            self.disable_initiator_tag = (gobject.timeout_add
1380
 
                                          (time_to_die, self.disable))
1381
 
    
1382
 
    # ExtendedTimeout - property
1383
 
    @dbus_service_property(_interface, signature="t",
1384
 
                           access="readwrite")
1385
 
    def ExtendedTimeout_dbus_property(self, value=None):
1386
 
        if value is None:       # get
1387
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
1388
 
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1389
 
    
1390
 
    # Interval - property
1391
 
    @dbus_service_property(_interface, signature="t",
1392
 
                           access="readwrite")
1393
 
    def Interval_dbus_property(self, value=None):
1394
 
        if value is None:       # get
1395
 
            return dbus.UInt64(self.interval_milliseconds())
1396
 
        self.interval = datetime.timedelta(0, 0, 0, value)
1397
 
        if getattr(self, "checker_initiator_tag", None) is None:
1398
 
            return
1399
 
        if self.enabled:
1400
 
            # Reschedule checker run
1401
 
            gobject.source_remove(self.checker_initiator_tag)
1402
 
            self.checker_initiator_tag = (gobject.timeout_add
1403
 
                                          (value, self.start_checker))
1404
 
            self.start_checker()    # Start one now, too
1405
 
    
1406
 
    # Checker - property
1407
 
    @dbus_service_property(_interface, signature="s",
1408
 
                           access="readwrite")
1409
 
    def Checker_dbus_property(self, value=None):
1410
 
        if value is None:       # get
1411
 
            return dbus.String(self.checker_command)
1412
 
        self.checker_command = unicode(value)
1413
 
    
1414
 
    # CheckerRunning - property
1415
 
    @dbus_service_property(_interface, signature="b",
1416
 
                           access="readwrite")
1417
 
    def CheckerRunning_dbus_property(self, value=None):
1418
 
        if value is None:       # get
1419
 
            return dbus.Boolean(self.checker is not None)
1420
 
        if value:
1421
 
            self.start_checker()
1422
 
        else:
1423
 
            self.stop_checker()
1424
 
    
1425
 
    # ObjectPath - property
1426
 
    @dbus_service_property(_interface, signature="o", access="read")
1427
 
    def ObjectPath_dbus_property(self):
1428
 
        return self.dbus_object_path # is already a dbus.ObjectPath
1429
 
    
1430
 
    # Secret = property
1431
 
    @dbus_service_property(_interface, signature="ay",
1432
 
                           access="write", byte_arrays=True)
1433
 
    def Secret_dbus_property(self, value):
1434
 
        self.secret = str(value)
1435
 
    
1436
 
    del _interface
1437
 
 
1438
 
 
1439
 
class ProxyClient(object):
1440
 
    def __init__(self, child_pipe, fpr, address):
1441
 
        self._pipe = child_pipe
1442
 
        self._pipe.send(('init', fpr, address))
1443
 
        if not self._pipe.recv():
1444
 
            raise KeyError()
1445
 
    
1446
 
    def __getattribute__(self, name):
1447
 
        if name == '_pipe':
1448
 
            return super(ProxyClient, self).__getattribute__(name)
1449
 
        self._pipe.send(('getattr', name))
1450
 
        data = self._pipe.recv()
1451
 
        if data[0] == 'data':
1452
 
            return data[1]
1453
 
        if data[0] == 'function':
1454
 
            def func(*args, **kwargs):
1455
 
                self._pipe.send(('funcall', name, args, kwargs))
1456
 
                return self._pipe.recv()[1]
1457
 
            return func
1458
 
    
1459
 
    def __setattr__(self, name, value):
1460
 
        if name == '_pipe':
1461
 
            return super(ProxyClient, self).__setattr__(name, value)
1462
 
        self._pipe.send(('setattr', name, value))
1463
 
 
1464
 
 
1465
 
class ClientDBusTransitional(ClientDBus):
1466
 
    __metaclass__ = AlternateDBusNamesMetaclass
1467
 
 
1468
 
 
1469
 
class ClientHandler(socketserver.BaseRequestHandler, object):
1470
 
    """A class to handle client connections.
1471
 
    
1472
 
    Instantiated once for each connection to handle it.
 
371
    def still_valid(self):
 
372
        """Has the timeout not yet passed for this client?"""
 
373
        now = datetime.datetime.now()
 
374
        if self.last_checked_ok is None:
 
375
            return now < (self.created + self.timeout)
 
376
        else:
 
377
            return now < (self.last_checked_ok + self.timeout)
 
378
 
 
379
 
 
380
def peer_certificate(session):
 
381
    "Return the peer's OpenPGP certificate as a bytestring"
 
382
    # If not an OpenPGP certificate...
 
383
    if gnutls.library.functions.gnutls_certificate_type_get\
 
384
            (session._c_object) \
 
385
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
 
386
        # ...do the normal thing
 
387
        return session.peer_certificate
 
388
    list_size = ctypes.c_uint()
 
389
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
390
        (session._c_object, ctypes.byref(list_size))
 
391
    if list_size.value == 0:
 
392
        return None
 
393
    cert = cert_list[0]
 
394
    return ctypes.string_at(cert.data, cert.size)
 
395
 
 
396
 
 
397
def fingerprint(openpgp):
 
398
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
399
    # New empty GnuTLS certificate
 
400
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
401
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
402
        (ctypes.byref(crt))
 
403
    # New GnuTLS "datum" with the OpenPGP public key
 
404
    datum = gnutls.library.types.gnutls_datum_t\
 
405
        (ctypes.cast(ctypes.c_char_p(openpgp),
 
406
                     ctypes.POINTER(ctypes.c_ubyte)),
 
407
         ctypes.c_uint(len(openpgp)))
 
408
    # Import the OpenPGP public key into the certificate
 
409
    ret = gnutls.library.functions.gnutls_openpgp_crt_import\
 
410
        (crt,
 
411
         ctypes.byref(datum),
 
412
         gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
413
    # New buffer for the fingerprint
 
414
    buffer = ctypes.create_string_buffer(20)
 
415
    buffer_length = ctypes.c_size_t()
 
416
    # Get the fingerprint from the certificate into the buffer
 
417
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
418
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
419
    # Deinit the certificate
 
420
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
421
    # Convert the buffer to a Python bytestring
 
422
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
423
    # Convert the bytestring to hexadecimal notation
 
424
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
425
    return hex_fpr
 
426
 
 
427
 
 
428
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
429
    """A TCP request handler class.
 
430
    Instantiated by IPv6_TCPServer for each request to handle it.
1473
431
    Note: This will run in its own forked process."""
1474
432
    
1475
433
    def handle(self):
1476
 
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1477
 
            logger.info("TCP connection from: %s",
1478
 
                        unicode(self.client_address))
1479
 
            logger.debug("Pipe FD: %d",
1480
 
                         self.server.child_pipe.fileno())
1481
 
            
1482
 
            session = (gnutls.connection
1483
 
                       .ClientSession(self.request,
1484
 
                                      gnutls.connection
1485
 
                                      .X509Credentials()))
1486
 
            
1487
 
            # Note: gnutls.connection.X509Credentials is really a
1488
 
            # generic GnuTLS certificate credentials object so long as
1489
 
            # no X.509 keys are added to it.  Therefore, we can use it
1490
 
            # here despite using OpenPGP certificates.
1491
 
            
1492
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1493
 
            #                      "+AES-256-CBC", "+SHA1",
1494
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1495
 
            #                      "+DHE-DSS"))
1496
 
            # Use a fallback default, since this MUST be set.
1497
 
            priority = self.server.gnutls_priority
1498
 
            if priority is None:
1499
 
                priority = "NORMAL"
1500
 
            (gnutls.library.functions
1501
 
             .gnutls_priority_set_direct(session._c_object,
1502
 
                                         priority, None))
1503
 
            
1504
 
            # Start communication using the Mandos protocol
1505
 
            # Get protocol number
1506
 
            line = self.request.makefile().readline()
1507
 
            logger.debug("Protocol version: %r", line)
1508
 
            try:
1509
 
                if int(line.strip().split()[0]) > 1:
1510
 
                    raise RuntimeError
1511
 
            except (ValueError, IndexError, RuntimeError) as error:
1512
 
                logger.error("Unknown protocol version: %s", error)
1513
 
                return
1514
 
            
1515
 
            # Start GnuTLS connection
1516
 
            try:
1517
 
                session.handshake()
1518
 
            except gnutls.errors.GNUTLSError as error:
1519
 
                logger.warning("Handshake failed: %s", error)
1520
 
                # Do not run session.bye() here: the session is not
1521
 
                # established.  Just abandon the request.
1522
 
                return
1523
 
            logger.debug("Handshake succeeded")
1524
 
            
1525
 
            approval_required = False
1526
 
            try:
1527
 
                try:
1528
 
                    fpr = self.fingerprint(self.peer_certificate
1529
 
                                           (session))
1530
 
                except (TypeError,
1531
 
                        gnutls.errors.GNUTLSError) as error:
1532
 
                    logger.warning("Bad certificate: %s", error)
1533
 
                    return
1534
 
                logger.debug("Fingerprint: %s", fpr)
1535
 
                
1536
 
                try:
1537
 
                    client = ProxyClient(child_pipe, fpr,
1538
 
                                         self.client_address)
1539
 
                except KeyError:
1540
 
                    return
1541
 
                
1542
 
                if self.server.use_dbus:
1543
 
                    # Emit D-Bus signal
1544
 
                    client.NewRequest(str(self.client_address))
1545
 
                
1546
 
                if client.approval_delay:
1547
 
                    delay = client.approval_delay
1548
 
                    client.approvals_pending += 1
1549
 
                    approval_required = True
1550
 
                
1551
 
                while True:
1552
 
                    if not client.enabled:
1553
 
                        logger.info("Client %s is disabled",
1554
 
                                       client.name)
1555
 
                        if self.server.use_dbus:
1556
 
                            # Emit D-Bus signal
1557
 
                            client.Rejected("Disabled")
1558
 
                        return
1559
 
                    
1560
 
                    if client.approved or not client.approval_delay:
1561
 
                        #We are approved or approval is disabled
1562
 
                        break
1563
 
                    elif client.approved is None:
1564
 
                        logger.info("Client %s needs approval",
1565
 
                                    client.name)
1566
 
                        if self.server.use_dbus:
1567
 
                            # Emit D-Bus signal
1568
 
                            client.NeedApproval(
1569
 
                                client.approval_delay_milliseconds(),
1570
 
                                client.approved_by_default)
1571
 
                    else:
1572
 
                        logger.warning("Client %s was not approved",
1573
 
                                       client.name)
1574
 
                        if self.server.use_dbus:
1575
 
                            # Emit D-Bus signal
1576
 
                            client.Rejected("Denied")
1577
 
                        return
1578
 
                    
1579
 
                    #wait until timeout or approved
1580
 
                    time = datetime.datetime.now()
1581
 
                    client.changedstate.acquire()
1582
 
                    (client.changedstate.wait
1583
 
                     (float(client.timedelta_to_milliseconds(delay)
1584
 
                            / 1000)))
1585
 
                    client.changedstate.release()
1586
 
                    time2 = datetime.datetime.now()
1587
 
                    if (time2 - time) >= delay:
1588
 
                        if not client.approved_by_default:
1589
 
                            logger.warning("Client %s timed out while"
1590
 
                                           " waiting for approval",
1591
 
                                           client.name)
1592
 
                            if self.server.use_dbus:
1593
 
                                # Emit D-Bus signal
1594
 
                                client.Rejected("Approval timed out")
1595
 
                            return
1596
 
                        else:
1597
 
                            break
1598
 
                    else:
1599
 
                        delay -= time2 - time
1600
 
                
1601
 
                sent_size = 0
1602
 
                while sent_size < len(client.secret):
1603
 
                    try:
1604
 
                        sent = session.send(client.secret[sent_size:])
1605
 
                    except gnutls.errors.GNUTLSError as error:
1606
 
                        logger.warning("gnutls send failed")
1607
 
                        return
1608
 
                    logger.debug("Sent: %d, remaining: %d",
1609
 
                                 sent, len(client.secret)
1610
 
                                 - (sent_size + sent))
1611
 
                    sent_size += sent
1612
 
                
1613
 
                logger.info("Sending secret to %s", client.name)
1614
 
                # bump the timeout using extended_timeout
1615
 
                client.checked_ok(client.extended_timeout)
1616
 
                if self.server.use_dbus:
1617
 
                    # Emit D-Bus signal
1618
 
                    client.GotSecret()
1619
 
            
1620
 
            finally:
1621
 
                if approval_required:
1622
 
                    client.approvals_pending -= 1
1623
 
                try:
1624
 
                    session.bye()
1625
 
                except gnutls.errors.GNUTLSError as error:
1626
 
                    logger.warning("GnuTLS bye failed")
1627
 
    
1628
 
    @staticmethod
1629
 
    def peer_certificate(session):
1630
 
        "Return the peer's OpenPGP certificate as a bytestring"
1631
 
        # If not an OpenPGP certificate...
1632
 
        if (gnutls.library.functions
1633
 
            .gnutls_certificate_type_get(session._c_object)
1634
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1635
 
            # ...do the normal thing
1636
 
            return session.peer_certificate
1637
 
        list_size = ctypes.c_uint(1)
1638
 
        cert_list = (gnutls.library.functions
1639
 
                     .gnutls_certificate_get_peers
1640
 
                     (session._c_object, ctypes.byref(list_size)))
1641
 
        if not bool(cert_list) and list_size.value != 0:
1642
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1643
 
                                            " certificate")
1644
 
        if list_size.value == 0:
1645
 
            return None
1646
 
        cert = cert_list[0]
1647
 
        return ctypes.string_at(cert.data, cert.size)
1648
 
    
1649
 
    @staticmethod
1650
 
    def fingerprint(openpgp):
1651
 
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1652
 
        # New GnuTLS "datum" with the OpenPGP public key
1653
 
        datum = (gnutls.library.types
1654
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1655
 
                                             ctypes.POINTER
1656
 
                                             (ctypes.c_ubyte)),
1657
 
                                 ctypes.c_uint(len(openpgp))))
1658
 
        # New empty GnuTLS certificate
1659
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1660
 
        (gnutls.library.functions
1661
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
1662
 
        # Import the OpenPGP public key into the certificate
1663
 
        (gnutls.library.functions
1664
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1665
 
                                    gnutls.library.constants
1666
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
1667
 
        # Verify the self signature in the key
1668
 
        crtverify = ctypes.c_uint()
1669
 
        (gnutls.library.functions
1670
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1671
 
                                         ctypes.byref(crtverify)))
1672
 
        if crtverify.value != 0:
1673
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1674
 
            raise (gnutls.errors.CertificateSecurityError
1675
 
                   ("Verify failed"))
1676
 
        # New buffer for the fingerprint
1677
 
        buf = ctypes.create_string_buffer(20)
1678
 
        buf_len = ctypes.c_size_t()
1679
 
        # Get the fingerprint from the certificate into the buffer
1680
 
        (gnutls.library.functions
1681
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1682
 
                                             ctypes.byref(buf_len)))
1683
 
        # Deinit the certificate
1684
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1685
 
        # Convert the buffer to a Python bytestring
1686
 
        fpr = ctypes.string_at(buf, buf_len.value)
1687
 
        # Convert the bytestring to hexadecimal notation
1688
 
        hex_fpr = binascii.hexlify(fpr).upper()
1689
 
        return hex_fpr
1690
 
 
1691
 
 
1692
 
class MultiprocessingMixIn(object):
1693
 
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
1694
 
    def sub_process_main(self, request, address):
1695
 
        try:
1696
 
            self.finish_request(request, address)
1697
 
        except Exception:
1698
 
            self.handle_error(request, address)
1699
 
        self.close_request(request)
1700
 
    
1701
 
    def process_request(self, request, address):
1702
 
        """Start a new process to process the request."""
1703
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1704
 
                                       args = (request,
1705
 
                                               address))
1706
 
        proc.start()
1707
 
        return proc
1708
 
 
1709
 
 
1710
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1711
 
    """ adds a pipe to the MixIn """
1712
 
    def process_request(self, request, client_address):
1713
 
        """Overrides and wraps the original process_request().
1714
 
        
1715
 
        This function creates a new pipe in self.pipe
1716
 
        """
1717
 
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1718
 
        
1719
 
        proc = MultiprocessingMixIn.process_request(self, request,
1720
 
                                                    client_address)
1721
 
        self.child_pipe.close()
1722
 
        self.add_pipe(parent_pipe, proc)
1723
 
    
1724
 
    def add_pipe(self, parent_pipe, proc):
1725
 
        """Dummy function; override as necessary"""
1726
 
        raise NotImplementedError
1727
 
 
1728
 
 
1729
 
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1730
 
                     socketserver.TCPServer, object):
1731
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1732
 
    
 
434
        logger.debug(u"TCP connection from: %s",
 
435
                     unicode(self.client_address))
 
436
        session = gnutls.connection.ClientSession\
 
437
                  (self.request, gnutls.connection.X509Credentials())
 
438
        # Note: gnutls.connection.X509Credentials is really a generic
 
439
        # GnuTLS certificate credentials object so long as no X.509
 
440
        # keys are added to it.  Therefore, we can use it here despite
 
441
        # using OpenPGP certificates.
 
442
        
 
443
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
 
444
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
445
        #                "+DHE-DSS"))
 
446
        priority = "NORMAL"             # Fallback default, since this
 
447
                                        # MUST be set.
 
448
        if self.server.settings["priority"]:
 
449
            priority = self.server.settings["priority"]
 
450
        gnutls.library.functions.gnutls_priority_set_direct\
 
451
            (session._c_object, priority, None);
 
452
        
 
453
        try:
 
454
            session.handshake()
 
455
        except gnutls.errors.GNUTLSError, error:
 
456
            logger.debug(u"Handshake failed: %s", error)
 
457
            # Do not run session.bye() here: the session is not
 
458
            # established.  Just abandon the request.
 
459
            return
 
460
        try:
 
461
            fpr = fingerprint(peer_certificate(session))
 
462
        except (TypeError, gnutls.errors.GNUTLSError), error:
 
463
            logger.debug(u"Bad certificate: %s", error)
 
464
            session.bye()
 
465
            return
 
466
        logger.debug(u"Fingerprint: %s", fpr)
 
467
        client = None
 
468
        for c in self.server.clients:
 
469
            if c.fingerprint == fpr:
 
470
                client = c
 
471
                break
 
472
        if not client:
 
473
            logger.debug(u"Client not found for fingerprint: %s", fpr)
 
474
            session.bye()
 
475
            return
 
476
        # Have to check if client.still_valid(), since it is possible
 
477
        # that the client timed out while establishing the GnuTLS
 
478
        # session.
 
479
        if not client.still_valid():
 
480
            logger.debug(u"Client %(name)s is invalid", vars(client))
 
481
            session.bye()
 
482
            return
 
483
        sent_size = 0
 
484
        while sent_size < len(client.secret):
 
485
            sent = session.send(client.secret[sent_size:])
 
486
            logger.debug(u"Sent: %d, remaining: %d",
 
487
                         sent, len(client.secret)
 
488
                         - (sent_size + sent))
 
489
            sent_size += sent
 
490
        session.bye()
 
491
 
 
492
 
 
493
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
494
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
1733
495
    Attributes:
1734
 
        enabled:        Boolean; whether this server is activated yet
1735
 
        interface:      None or a network interface name (string)
1736
 
        use_ipv6:       Boolean; to use IPv6 or not
 
496
        settings:       Server settings
 
497
        clients:        Set() of Client objects
1737
498
    """
1738
 
    def __init__(self, server_address, RequestHandlerClass,
1739
 
                 interface=None, use_ipv6=True):
1740
 
        self.interface = interface
1741
 
        if use_ipv6:
1742
 
            self.address_family = socket.AF_INET6
1743
 
        socketserver.TCPServer.__init__(self, server_address,
1744
 
                                        RequestHandlerClass)
 
499
    address_family = socket.AF_INET6
 
500
    def __init__(self, *args, **kwargs):
 
501
        if "settings" in kwargs:
 
502
            self.settings = kwargs["settings"]
 
503
            del kwargs["settings"]
 
504
        if "clients" in kwargs:
 
505
            self.clients = kwargs["clients"]
 
506
            del kwargs["clients"]
 
507
        return super(type(self), self).__init__(*args, **kwargs)
1745
508
    def server_bind(self):
1746
509
        """This overrides the normal server_bind() function
1747
510
        to bind to an interface if one was specified, and also NOT to
1748
511
        bind to an address or port if they were not specified."""
1749
 
        if self.interface is not None:
1750
 
            if SO_BINDTODEVICE is None:
1751
 
                logger.error("SO_BINDTODEVICE does not exist;"
1752
 
                             " cannot bind to interface %s",
1753
 
                             self.interface)
1754
 
            else:
1755
 
                try:
1756
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1757
 
                                           SO_BINDTODEVICE,
1758
 
                                           str(self.interface
1759
 
                                               + '\0'))
1760
 
                except socket.error as error:
1761
 
                    if error[0] == errno.EPERM:
1762
 
                        logger.error("No permission to"
1763
 
                                     " bind to interface %s",
1764
 
                                     self.interface)
1765
 
                    elif error[0] == errno.ENOPROTOOPT:
1766
 
                        logger.error("SO_BINDTODEVICE not available;"
1767
 
                                     " cannot bind to interface %s",
1768
 
                                     self.interface)
1769
 
                    else:
1770
 
                        raise
 
512
        if self.settings["interface"] != avahi.IF_UNSPEC:
 
513
            # 25 is from /usr/include/asm-i486/socket.h
 
514
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
515
            try:
 
516
                self.socket.setsockopt(socket.SOL_SOCKET,
 
517
                                       SO_BINDTODEVICE,
 
518
                                       self.settings["interface"])
 
519
            except socket.error, error:
 
520
                if error[0] == errno.EPERM:
 
521
                    logger.warning(u"No permission to"
 
522
                                   u" bind to interface %s",
 
523
                                   self.settings["interface"])
 
524
                else:
 
525
                    raise error
1771
526
        # Only bind(2) the socket if we really need to.
1772
527
        if self.server_address[0] or self.server_address[1]:
1773
528
            if not self.server_address[0]:
1774
 
                if self.address_family == socket.AF_INET6:
1775
 
                    any_address = "::" # in6addr_any
1776
 
                else:
1777
 
                    any_address = socket.INADDR_ANY
1778
 
                self.server_address = (any_address,
 
529
                in6addr_any = "::"
 
530
                self.server_address = (in6addr_any,
1779
531
                                       self.server_address[1])
1780
 
            elif not self.server_address[1]:
 
532
            elif self.server_address[1] is None:
1781
533
                self.server_address = (self.server_address[0],
1782
534
                                       0)
1783
 
#                 if self.interface:
1784
 
#                     self.server_address = (self.server_address[0],
1785
 
#                                            0, # port
1786
 
#                                            0, # flowinfo
1787
 
#                                            if_nametoindex
1788
 
#                                            (self.interface))
1789
 
            return socketserver.TCPServer.server_bind(self)
1790
 
 
1791
 
 
1792
 
class MandosServer(IPv6_TCPServer):
1793
 
    """Mandos server.
1794
 
    
1795
 
    Attributes:
1796
 
        clients:        set of Client objects
1797
 
        gnutls_priority GnuTLS priority string
1798
 
        use_dbus:       Boolean; to emit D-Bus signals or not
1799
 
    
1800
 
    Assumes a gobject.MainLoop event loop.
1801
 
    """
1802
 
    def __init__(self, server_address, RequestHandlerClass,
1803
 
                 interface=None, use_ipv6=True, clients=None,
1804
 
                 gnutls_priority=None, use_dbus=True):
1805
 
        self.enabled = False
1806
 
        self.clients = clients
1807
 
        if self.clients is None:
1808
 
            self.clients = {}
1809
 
        self.use_dbus = use_dbus
1810
 
        self.gnutls_priority = gnutls_priority
1811
 
        IPv6_TCPServer.__init__(self, server_address,
1812
 
                                RequestHandlerClass,
1813
 
                                interface = interface,
1814
 
                                use_ipv6 = use_ipv6)
1815
 
    def server_activate(self):
1816
 
        if self.enabled:
1817
 
            return socketserver.TCPServer.server_activate(self)
1818
 
    
1819
 
    def enable(self):
1820
 
        self.enabled = True
1821
 
    
1822
 
    def add_pipe(self, parent_pipe, proc):
1823
 
        # Call "handle_ipc" for both data and EOF events
1824
 
        gobject.io_add_watch(parent_pipe.fileno(),
1825
 
                             gobject.IO_IN | gobject.IO_HUP,
1826
 
                             functools.partial(self.handle_ipc,
1827
 
                                               parent_pipe =
1828
 
                                               parent_pipe,
1829
 
                                               proc = proc))
1830
 
    
1831
 
    def handle_ipc(self, source, condition, parent_pipe=None,
1832
 
                   proc = None, client_object=None):
1833
 
        condition_names = {
1834
 
            gobject.IO_IN: "IN",   # There is data to read.
1835
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1836
 
                                    # blocking).
1837
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1838
 
            gobject.IO_ERR: "ERR", # Error condition.
1839
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1840
 
                                    # broken, usually for pipes and
1841
 
                                    # sockets).
1842
 
            }
1843
 
        conditions_string = ' | '.join(name
1844
 
                                       for cond, name in
1845
 
                                       condition_names.iteritems()
1846
 
                                       if cond & condition)
1847
 
        # error, or the other end of multiprocessing.Pipe has closed
1848
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1849
 
            # Wait for other process to exit
1850
 
            proc.join()
1851
 
            return False
1852
 
        
1853
 
        # Read a request from the child
1854
 
        request = parent_pipe.recv()
1855
 
        command = request[0]
1856
 
        
1857
 
        if command == 'init':
1858
 
            fpr = request[1]
1859
 
            address = request[2]
1860
 
            
1861
 
            for c in self.clients.itervalues():
1862
 
                if c.fingerprint == fpr:
1863
 
                    client = c
1864
 
                    break
1865
 
            else:
1866
 
                logger.info("Client not found for fingerprint: %s, ad"
1867
 
                            "dress: %s", fpr, address)
1868
 
                if self.use_dbus:
1869
 
                    # Emit D-Bus signal
1870
 
                    mandos_dbus_service.ClientNotFound(fpr,
1871
 
                                                       address[0])
1872
 
                parent_pipe.send(False)
1873
 
                return False
1874
 
            
1875
 
            gobject.io_add_watch(parent_pipe.fileno(),
1876
 
                                 gobject.IO_IN | gobject.IO_HUP,
1877
 
                                 functools.partial(self.handle_ipc,
1878
 
                                                   parent_pipe =
1879
 
                                                   parent_pipe,
1880
 
                                                   proc = proc,
1881
 
                                                   client_object =
1882
 
                                                   client))
1883
 
            parent_pipe.send(True)
1884
 
            # remove the old hook in favor of the new above hook on
1885
 
            # same fileno
1886
 
            return False
1887
 
        if command == 'funcall':
1888
 
            funcname = request[1]
1889
 
            args = request[2]
1890
 
            kwargs = request[3]
1891
 
            
1892
 
            parent_pipe.send(('data', getattr(client_object,
1893
 
                                              funcname)(*args,
1894
 
                                                         **kwargs)))
1895
 
        
1896
 
        if command == 'getattr':
1897
 
            attrname = request[1]
1898
 
            if callable(client_object.__getattribute__(attrname)):
1899
 
                parent_pipe.send(('function',))
1900
 
            else:
1901
 
                parent_pipe.send(('data', client_object
1902
 
                                  .__getattribute__(attrname)))
1903
 
        
1904
 
        if command == 'setattr':
1905
 
            attrname = request[1]
1906
 
            value = request[2]
1907
 
            setattr(client_object, attrname, value)
1908
 
        
1909
 
        return True
 
535
            return super(type(self), self).server_bind()
1910
536
 
1911
537
 
1912
538
def string_to_delta(interval):
1913
539
    """Parse a string and return a datetime.timedelta
1914
 
    
 
540
 
1915
541
    >>> string_to_delta('7d')
1916
542
    datetime.timedelta(7)
1917
543
    >>> string_to_delta('60s')
1920
546
    datetime.timedelta(0, 3600)
1921
547
    >>> string_to_delta('24h')
1922
548
    datetime.timedelta(1)
1923
 
    >>> string_to_delta('1w')
 
549
    >>> string_to_delta(u'1w')
1924
550
    datetime.timedelta(7)
1925
 
    >>> string_to_delta('5m 30s')
1926
 
    datetime.timedelta(0, 330)
1927
551
    """
1928
 
    timevalue = datetime.timedelta(0)
1929
 
    for s in interval.split():
1930
 
        try:
1931
 
            suffix = unicode(s[-1])
1932
 
            value = int(s[:-1])
1933
 
            if suffix == "d":
1934
 
                delta = datetime.timedelta(value)
1935
 
            elif suffix == "s":
1936
 
                delta = datetime.timedelta(0, value)
1937
 
            elif suffix == "m":
1938
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
1939
 
            elif suffix == "h":
1940
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1941
 
            elif suffix == "w":
1942
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1943
 
            else:
1944
 
                raise ValueError("Unknown suffix %r" % suffix)
1945
 
        except (ValueError, IndexError) as e:
1946
 
            raise ValueError(*(e.args))
1947
 
        timevalue += delta
1948
 
    return timevalue
1949
 
 
1950
 
 
1951
 
def daemon(nochdir = False, noclose = False):
 
552
    try:
 
553
        suffix=unicode(interval[-1])
 
554
        value=int(interval[:-1])
 
555
        if suffix == u"d":
 
556
            delta = datetime.timedelta(value)
 
557
        elif suffix == u"s":
 
558
            delta = datetime.timedelta(0, value)
 
559
        elif suffix == u"m":
 
560
            delta = datetime.timedelta(0, 0, 0, 0, value)
 
561
        elif suffix == u"h":
 
562
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
563
        elif suffix == u"w":
 
564
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
565
        else:
 
566
            raise ValueError
 
567
    except (ValueError, IndexError):
 
568
        raise ValueError
 
569
    return delta
 
570
 
 
571
 
 
572
def server_state_changed(state):
 
573
    """Derived from the Avahi example code"""
 
574
    if state == avahi.SERVER_COLLISION:
 
575
        logger.warning(u"Server name collision")
 
576
        service.remove()
 
577
    elif state == avahi.SERVER_RUNNING:
 
578
        service.add()
 
579
 
 
580
 
 
581
def entry_group_state_changed(state, error):
 
582
    """Derived from the Avahi example code"""
 
583
    logger.debug(u"state change: %i", state)
 
584
    
 
585
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
586
        logger.debug(u"Service established.")
 
587
    elif state == avahi.ENTRY_GROUP_COLLISION:
 
588
        logger.warning(u"Service name collision.")
 
589
        service.rename()
 
590
    elif state == avahi.ENTRY_GROUP_FAILURE:
 
591
        logger.critical(u"Error in group state changed %s",
 
592
                        unicode(error))
 
593
        raise AvahiGroupError("State changed: %s", str(error))
 
594
 
 
595
def if_nametoindex(interface, _func=[None]):
 
596
    """Call the C function if_nametoindex(), or equivalent"""
 
597
    if _func[0] is not None:
 
598
        return _func[0](interface)
 
599
    try:
 
600
        if "ctypes.util" not in sys.modules:
 
601
            import ctypes.util
 
602
        while True:
 
603
            try:
 
604
                libc = ctypes.cdll.LoadLibrary\
 
605
                       (ctypes.util.find_library("c"))
 
606
                func[0] = libc.if_nametoindex
 
607
                return _func[0](interface)
 
608
            except IOError, e:
 
609
                if e != errno.EINTR:
 
610
                    raise
 
611
    except (OSError, AttributeError):
 
612
        if "struct" not in sys.modules:
 
613
            import struct
 
614
        if "fcntl" not in sys.modules:
 
615
            import fcntl
 
616
        def the_hard_way(interface):
 
617
            "Get an interface index the hard way, i.e. using fcntl()"
 
618
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
619
            s = socket.socket()
 
620
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
621
                                struct.pack("16s16x", interface))
 
622
            s.close()
 
623
            interface_index = struct.unpack("I", ifreq[16:20])[0]
 
624
            return interface_index
 
625
        _func[0] = the_hard_way
 
626
        return _func[0](interface)
 
627
 
 
628
 
 
629
def daemon(nochdir, noclose):
1952
630
    """See daemon(3).  Standard BSD Unix function.
1953
 
    
1954
631
    This should really exist as os.daemon, but it doesn't (yet)."""
1955
632
    if os.fork():
1956
633
        sys.exit()
1957
634
    os.setsid()
1958
635
    if not nochdir:
1959
636
        os.chdir("/")
1960
 
    if os.fork():
1961
 
        sys.exit()
1962
637
    if not noclose:
1963
638
        # Close all standard open file descriptors
1964
639
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1965
640
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1966
641
            raise OSError(errno.ENODEV,
1967
 
                          "%s not a character device"
1968
 
                          % os.path.devnull)
 
642
                          "/dev/null not a character device")
1969
643
        os.dup2(null, sys.stdin.fileno())
1970
644
        os.dup2(null, sys.stdout.fileno())
1971
645
        os.dup2(null, sys.stderr.fileno())
1974
648
 
1975
649
 
1976
650
def main():
1977
 
    
1978
 
    ##################################################################
1979
 
    # Parsing of options, both command line and config file
1980
 
    
1981
 
    parser = argparse.ArgumentParser()
1982
 
    parser.add_argument("-v", "--version", action="version",
1983
 
                        version = "%%(prog)s %s" % version,
1984
 
                        help="show version number and exit")
1985
 
    parser.add_argument("-i", "--interface", metavar="IF",
1986
 
                        help="Bind to interface IF")
1987
 
    parser.add_argument("-a", "--address",
1988
 
                        help="Address to listen for requests on")
1989
 
    parser.add_argument("-p", "--port", type=int,
1990
 
                        help="Port number to receive requests on")
1991
 
    parser.add_argument("--check", action="store_true",
1992
 
                        help="Run self-test")
1993
 
    parser.add_argument("--debug", action="store_true",
1994
 
                        help="Debug mode; run in foreground and log"
1995
 
                        " to terminal")
1996
 
    parser.add_argument("--debuglevel", metavar="LEVEL",
1997
 
                        help="Debug level for stdout output")
1998
 
    parser.add_argument("--priority", help="GnuTLS"
1999
 
                        " priority string (see GnuTLS documentation)")
2000
 
    parser.add_argument("--servicename",
2001
 
                        metavar="NAME", help="Zeroconf service name")
2002
 
    parser.add_argument("--configdir",
2003
 
                        default="/etc/mandos", metavar="DIR",
2004
 
                        help="Directory to search for configuration"
2005
 
                        " files")
2006
 
    parser.add_argument("--no-dbus", action="store_false",
2007
 
                        dest="use_dbus", help="Do not provide D-Bus"
2008
 
                        " system bus interface")
2009
 
    parser.add_argument("--no-ipv6", action="store_false",
2010
 
                        dest="use_ipv6", help="Do not use IPv6")
2011
 
    parser.add_argument("--no-restore", action="store_false",
2012
 
                        dest="restore", help="Do not restore stored"
2013
 
                        " state")
2014
 
    parser.add_argument("--statedir", metavar="DIR",
2015
 
                        help="Directory to save/restore state in")
2016
 
    
2017
 
    options = parser.parse_args()
 
651
    global main_loop_started
 
652
    main_loop_started = False
 
653
    
 
654
    parser = OptionParser()
 
655
    parser.add_option("-i", "--interface", type="string",
 
656
                      metavar="IF", help="Bind to interface IF")
 
657
    parser.add_option("-a", "--address", type="string",
 
658
                      help="Address to listen for requests on")
 
659
    parser.add_option("-p", "--port", type="int",
 
660
                      help="Port number to receive requests on")
 
661
    parser.add_option("--check", action="store_true", default=False,
 
662
                      help="Run self-test")
 
663
    parser.add_option("--debug", action="store_true", default=False,
 
664
                      help="Debug mode; run in foreground and log to"
 
665
                      " terminal")
 
666
    parser.add_option("--priority", type="string", help="GnuTLS"
 
667
                      " priority string (see GnuTLS documentation)")
 
668
    parser.add_option("--servicename", type="string", metavar="NAME",
 
669
                      help="Zeroconf service name")
 
670
    parser.add_option("--configdir", type="string",
 
671
                      default="/etc/mandos", metavar="DIR",
 
672
                      help="Directory to search for configuration"
 
673
                      " files")
 
674
    (options, args) = parser.parse_args()
2018
675
    
2019
676
    if options.check:
2020
677
        import doctest
2029
686
                        "priority":
2030
687
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2031
688
                        "servicename": "Mandos",
2032
 
                        "use_dbus": "True",
2033
 
                        "use_ipv6": "True",
2034
 
                        "debuglevel": "",
2035
 
                        "restore": "True",
2036
 
                        "statedir": "/var/lib/mandos"
2037
689
                        }
2038
690
    
2039
691
    # Parse config file for server-global settings
2040
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
692
    server_config = ConfigParser.SafeConfigParser(server_defaults)
2041
693
    del server_defaults
2042
 
    server_config.read(os.path.join(options.configdir,
2043
 
                                    "mandos.conf"))
 
694
    server_config.read(os.path.join(options.configdir, "server.conf"))
 
695
    server_section = "server"
2044
696
    # Convert the SafeConfigParser object to a dict
2045
 
    server_settings = server_config.defaults()
2046
 
    # Use the appropriate methods on the non-string config options
2047
 
    for option in ("debug", "use_dbus", "use_ipv6"):
2048
 
        server_settings[option] = server_config.getboolean("DEFAULT",
2049
 
                                                           option)
2050
 
    if server_settings["port"]:
2051
 
        server_settings["port"] = server_config.getint("DEFAULT",
2052
 
                                                       "port")
 
697
    server_settings = dict(server_config.items(server_section))
 
698
    # Use getboolean on the boolean config option
 
699
    server_settings["debug"] = server_config.getboolean\
 
700
                               (server_section, "debug")
2053
701
    del server_config
 
702
    if not server_settings["interface"]:
 
703
        server_settings["interface"] = avahi.IF_UNSPEC
2054
704
    
2055
705
    # Override the settings from the config file with command line
2056
706
    # options, if set.
2057
707
    for option in ("interface", "address", "port", "debug",
2058
 
                   "priority", "servicename", "configdir",
2059
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2060
 
                   "statedir"):
 
708
                   "priority", "servicename", "configdir"):
2061
709
        value = getattr(options, option)
2062
710
        if value is not None:
2063
711
            server_settings[option] = value
2064
712
    del options
2065
 
    # Force all strings to be unicode
2066
 
    for option in server_settings.keys():
2067
 
        if type(server_settings[option]) is str:
2068
 
            server_settings[option] = unicode(server_settings[option])
2069
713
    # Now we have our good server settings in "server_settings"
2070
714
    
2071
 
    ##################################################################
2072
 
    
2073
 
    # For convenience
2074
 
    debug = server_settings["debug"]
2075
 
    debuglevel = server_settings["debuglevel"]
2076
 
    use_dbus = server_settings["use_dbus"]
2077
 
    use_ipv6 = server_settings["use_ipv6"]
2078
 
    stored_state_path = os.path.join(server_settings["statedir"],
2079
 
                                     stored_state_file)
2080
 
    
2081
 
    if debug:
2082
 
        initlogger(debug, logging.DEBUG)
2083
 
    else:
2084
 
        if not debuglevel:
2085
 
            initlogger(debug)
2086
 
        else:
2087
 
            level = getattr(logging, debuglevel.upper())
2088
 
            initlogger(debug, level)
2089
 
    
2090
 
    if server_settings["servicename"] != "Mandos":
2091
 
        syslogger.setFormatter(logging.Formatter
2092
 
                               ('Mandos (%s) [%%(process)d]:'
2093
 
                                ' %%(levelname)s: %%(message)s'
2094
 
                                % server_settings["servicename"]))
2095
 
    
2096
715
    # Parse config file with clients
2097
 
    client_config = configparser.SafeConfigParser(Client.client_defaults)
 
716
    client_defaults = { "timeout": "1h",
 
717
                        "interval": "5m",
 
718
                        "checker": "fping -q -- %%(fqdn)s",
 
719
                        }
 
720
    client_config = ConfigParser.SafeConfigParser(client_defaults)
2098
721
    client_config.read(os.path.join(server_settings["configdir"],
2099
722
                                    "clients.conf"))
2100
723
    
2101
 
    global mandos_dbus_service
2102
 
    mandos_dbus_service = None
2103
 
    
2104
 
    tcp_server = MandosServer((server_settings["address"],
2105
 
                               server_settings["port"]),
2106
 
                              ClientHandler,
2107
 
                              interface=(server_settings["interface"]
2108
 
                                         or None),
2109
 
                              use_ipv6=use_ipv6,
2110
 
                              gnutls_priority=
2111
 
                              server_settings["priority"],
2112
 
                              use_dbus=use_dbus)
2113
 
    if not debug:
2114
 
        pidfilename = "/var/run/mandos.pid"
2115
 
        try:
2116
 
            pidfile = open(pidfilename, "w")
2117
 
        except IOError:
2118
 
            logger.error("Could not open file %r", pidfilename)
2119
 
    
2120
 
    try:
2121
 
        uid = pwd.getpwnam("_mandos").pw_uid
2122
 
        gid = pwd.getpwnam("_mandos").pw_gid
2123
 
    except KeyError:
2124
 
        try:
2125
 
            uid = pwd.getpwnam("mandos").pw_uid
2126
 
            gid = pwd.getpwnam("mandos").pw_gid
2127
 
        except KeyError:
2128
 
            try:
2129
 
                uid = pwd.getpwnam("nobody").pw_uid
2130
 
                gid = pwd.getpwnam("nobody").pw_gid
2131
 
            except KeyError:
2132
 
                uid = 65534
2133
 
                gid = 65534
2134
 
    try:
2135
 
        os.setgid(gid)
2136
 
        os.setuid(uid)
2137
 
    except OSError as error:
2138
 
        if error[0] != errno.EPERM:
2139
 
            raise error
2140
 
    
2141
 
    if debug:
2142
 
        # Enable all possible GnuTLS debugging
2143
 
        
2144
 
        # "Use a log level over 10 to enable all debugging options."
2145
 
        # - GnuTLS manual
2146
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
2147
 
        
2148
 
        @gnutls.library.types.gnutls_log_func
2149
 
        def debug_gnutls(level, string):
2150
 
            logger.debug("GnuTLS: %s", string[:-1])
2151
 
        
2152
 
        (gnutls.library.functions
2153
 
         .gnutls_global_set_log_function(debug_gnutls))
2154
 
        
2155
 
        # Redirect stdin so all checkers get /dev/null
2156
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2157
 
        os.dup2(null, sys.stdin.fileno())
2158
 
        if null > 2:
2159
 
            os.close(null)
2160
 
    
2161
 
    # Need to fork before connecting to D-Bus
2162
 
    if not debug:
2163
 
        # Close all input and output, do double fork, etc.
2164
 
        daemon()
2165
 
    
2166
 
    gobject.threads_init()
 
724
    global service
 
725
    service = AvahiService(name = server_settings["servicename"],
 
726
                           type = "_mandos._tcp", );
2167
727
    
2168
728
    global main_loop
 
729
    global bus
 
730
    global server
2169
731
    # From the Avahi example code
2170
732
    DBusGMainLoop(set_as_default=True )
2171
733
    main_loop = gobject.MainLoop()
2172
734
    bus = dbus.SystemBus()
 
735
    server = dbus.Interface(
 
736
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
737
            avahi.DBUS_INTERFACE_SERVER )
2173
738
    # End of Avahi example code
2174
 
    if use_dbus:
2175
 
        try:
2176
 
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2177
 
                                            bus, do_not_queue=True)
2178
 
            old_bus_name = (dbus.service.BusName
2179
 
                            ("se.bsnet.fukt.Mandos", bus,
2180
 
                             do_not_queue=True))
2181
 
        except dbus.exceptions.NameExistsException as e:
2182
 
            logger.error(unicode(e) + ", disabling D-Bus")
2183
 
            use_dbus = False
2184
 
            server_settings["use_dbus"] = False
2185
 
            tcp_server.use_dbus = False
2186
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2187
 
    service = AvahiServiceToSyslog(name =
2188
 
                                   server_settings["servicename"],
2189
 
                                   servicetype = "_mandos._tcp",
2190
 
                                   protocol = protocol, bus = bus)
2191
 
    if server_settings["interface"]:
2192
 
        service.interface = (if_nametoindex
2193
 
                             (str(server_settings["interface"])))
2194
 
    
2195
 
    global multiprocessing_manager
2196
 
    multiprocessing_manager = multiprocessing.Manager()
2197
 
    
2198
 
    client_class = Client
2199
 
    if use_dbus:
2200
 
        client_class = functools.partial(ClientDBusTransitional,
2201
 
                                         bus = bus)
2202
 
    
2203
 
    client_settings = Client.config_parser(client_config)
2204
 
    old_client_settings = {}
2205
 
    clients_data = {}
2206
 
    
2207
 
    # Get client data and settings from last running state.
2208
 
    if server_settings["restore"]:
2209
 
        try:
2210
 
            with open(stored_state_path, "rb") as stored_state:
2211
 
                clients_data, old_client_settings = (pickle.load
2212
 
                                                     (stored_state))
2213
 
            os.remove(stored_state_path)
2214
 
        except IOError as e:
2215
 
            logger.warning("Could not load persistent state: {0}"
2216
 
                           .format(e))
2217
 
            if e.errno != errno.ENOENT:
2218
 
                raise
2219
 
        except EOFError as e:
2220
 
            logger.warning("Could not load persistent state: "
2221
 
                           "EOFError: {0}".format(e))
2222
 
    
2223
 
    with PGPEngine() as pgp:
2224
 
        for client_name, client in clients_data.iteritems():
2225
 
            # Decide which value to use after restoring saved state.
2226
 
            # We have three different values: Old config file,
2227
 
            # new config file, and saved state.
2228
 
            # New config value takes precedence if it differs from old
2229
 
            # config value, otherwise use saved state.
2230
 
            for name, value in client_settings[client_name].items():
2231
 
                try:
2232
 
                    # For each value in new config, check if it
2233
 
                    # differs from the old config value (Except for
2234
 
                    # the "secret" attribute)
2235
 
                    if (name != "secret" and
2236
 
                        value != old_client_settings[client_name]
2237
 
                        [name]):
2238
 
                        client[name] = value
2239
 
                except KeyError:
2240
 
                    pass
2241
 
            
2242
 
            # Clients who has passed its expire date can still be
2243
 
            # enabled if its last checker was successful.  Clients
2244
 
            # whose checker failed before we stored its state is
2245
 
            # assumed to have failed all checkers during downtime.
2246
 
            if client["enabled"]:
2247
 
                if datetime.datetime.utcnow() >= client["expires"]:
2248
 
                    if not client["last_checked_ok"]:
2249
 
                        logger.warning(
2250
 
                            "disabling client {0} - Client never "
2251
 
                            "performed a successfull checker"
2252
 
                            .format(client["name"]))
2253
 
                        client["enabled"] = False
2254
 
                    elif client["last_checker_status"] != 0:
2255
 
                        logger.warning(
2256
 
                            "disabling client {0} - Client "
2257
 
                            "last checker failed with error code {1}"
2258
 
                            .format(client["name"],
2259
 
                                    client["last_checker_status"]))
2260
 
                        client["enabled"] = False
2261
 
                    else:
2262
 
                        client["expires"] = (datetime.datetime
2263
 
                                             .utcnow()
2264
 
                                             + client["timeout"])
2265
 
                    
2266
 
            try:
2267
 
                client["secret"] = (
2268
 
                    pgp.decrypt(client["encrypted_secret"],
2269
 
                                client_settings[client_name]
2270
 
                                ["secret"]))
2271
 
            except PGPError:
2272
 
                # If decryption fails, we use secret from new settings
2273
 
                logger.debug("Failed to decrypt {0} old secret"
2274
 
                             .format(client_name))
2275
 
                client["secret"] = (
2276
 
                    client_settings[client_name]["secret"])
2277
 
 
2278
 
    
2279
 
    # Add/remove clients based on new changes made to config
2280
 
    for client_name in set(old_client_settings) - set(client_settings):
2281
 
        del clients_data[client_name]
2282
 
    for client_name in set(client_settings) - set(old_client_settings):
2283
 
        clients_data[client_name] = client_settings[client_name]
2284
 
 
2285
 
    # Create clients all clients
2286
 
    for client_name, client in clients_data.iteritems():
2287
 
        tcp_server.clients[client_name] = client_class(
2288
 
            name = client_name, settings = client)
2289
 
    
2290
 
    if not tcp_server.clients:
2291
 
        logger.warning("No clients defined")
 
739
    
 
740
    debug = server_settings["debug"]
 
741
    
 
742
    if debug:
 
743
        console = logging.StreamHandler()
 
744
        # console.setLevel(logging.DEBUG)
 
745
        console.setFormatter(logging.Formatter\
 
746
                             ('%(levelname)s: %(message)s'))
 
747
        logger.addHandler(console)
 
748
        del console
 
749
    
 
750
    clients = Set()
 
751
    def remove_from_clients(client):
 
752
        clients.remove(client)
 
753
        if not clients:
 
754
            logger.debug(u"No clients left, exiting")
 
755
            sys.exit()
 
756
    
 
757
    clients.update(Set(Client(name=section,
 
758
                              stop_hook = remove_from_clients,
 
759
                              **(dict(client_config\
 
760
                                      .items(section))))
 
761
                       for section in client_config.sections()))
 
762
    
 
763
    if not debug:
 
764
        daemon(False, False)
 
765
    
 
766
    def cleanup():
 
767
        "Cleanup function; run on exit"
 
768
        global group
 
769
        # From the Avahi example code
 
770
        if not group is None:
 
771
            group.Free()
 
772
            group = None
 
773
        # End of Avahi example code
2292
774
        
 
775
        while clients:
 
776
            client = clients.pop()
 
777
            client.stop_hook = None
 
778
            client.stop()
 
779
    
 
780
    atexit.register(cleanup)
 
781
    
2293
782
    if not debug:
2294
 
        try:
2295
 
            with pidfile:
2296
 
                pid = os.getpid()
2297
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2298
 
            del pidfile
2299
 
        except IOError:
2300
 
            logger.error("Could not write to file %r with PID %d",
2301
 
                         pidfilename, pid)
2302
 
        except NameError:
2303
 
            # "pidfile" was never created
2304
 
            pass
2305
 
        del pidfilename
2306
783
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2307
 
    
2308
784
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2309
785
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2310
786
    
2311
 
    if use_dbus:
2312
 
        class MandosDBusService(dbus.service.Object):
2313
 
            """A D-Bus proxy object"""
2314
 
            def __init__(self):
2315
 
                dbus.service.Object.__init__(self, bus, "/")
2316
 
            _interface = "se.recompile.Mandos"
2317
 
            
2318
 
            @dbus.service.signal(_interface, signature="o")
2319
 
            def ClientAdded(self, objpath):
2320
 
                "D-Bus signal"
2321
 
                pass
2322
 
            
2323
 
            @dbus.service.signal(_interface, signature="ss")
2324
 
            def ClientNotFound(self, fingerprint, address):
2325
 
                "D-Bus signal"
2326
 
                pass
2327
 
            
2328
 
            @dbus.service.signal(_interface, signature="os")
2329
 
            def ClientRemoved(self, objpath, name):
2330
 
                "D-Bus signal"
2331
 
                pass
2332
 
            
2333
 
            @dbus.service.method(_interface, out_signature="ao")
2334
 
            def GetAllClients(self):
2335
 
                "D-Bus method"
2336
 
                return dbus.Array(c.dbus_object_path
2337
 
                                  for c in
2338
 
                                  tcp_server.clients.itervalues())
2339
 
            
2340
 
            @dbus.service.method(_interface,
2341
 
                                 out_signature="a{oa{sv}}")
2342
 
            def GetAllClientsWithProperties(self):
2343
 
                "D-Bus method"
2344
 
                return dbus.Dictionary(
2345
 
                    ((c.dbus_object_path, c.GetAll(""))
2346
 
                     for c in tcp_server.clients.itervalues()),
2347
 
                    signature="oa{sv}")
2348
 
            
2349
 
            @dbus.service.method(_interface, in_signature="o")
2350
 
            def RemoveClient(self, object_path):
2351
 
                "D-Bus method"
2352
 
                for c in tcp_server.clients.itervalues():
2353
 
                    if c.dbus_object_path == object_path:
2354
 
                        del tcp_server.clients[c.name]
2355
 
                        c.remove_from_connection()
2356
 
                        # Don't signal anything except ClientRemoved
2357
 
                        c.disable(quiet=True)
2358
 
                        # Emit D-Bus signal
2359
 
                        self.ClientRemoved(object_path, c.name)
2360
 
                        return
2361
 
                raise KeyError(object_path)
2362
 
            
2363
 
            del _interface
2364
 
        
2365
 
        class MandosDBusServiceTransitional(MandosDBusService):
2366
 
            __metaclass__ = AlternateDBusNamesMetaclass
2367
 
        mandos_dbus_service = MandosDBusServiceTransitional()
2368
 
    
2369
 
    def cleanup():
2370
 
        "Cleanup function; run on exit"
2371
 
        service.cleanup()
2372
 
        
2373
 
        multiprocessing.active_children()
2374
 
        if not (tcp_server.clients or client_settings):
2375
 
            return
2376
 
        
2377
 
        # Store client before exiting. Secrets are encrypted with key
2378
 
        # based on what config file has. If config file is
2379
 
        # removed/edited, old secret will thus be unrecovable.
2380
 
        clients = {}
2381
 
        with PGPEngine() as pgp:
2382
 
            for client in tcp_server.clients.itervalues():
2383
 
                key = client_settings[client.name]["secret"]
2384
 
                client.encrypted_secret = pgp.encrypt(client.secret,
2385
 
                                                      key)
2386
 
                client_dict = {}
2387
 
                
2388
 
                # A list of attributes that can not be pickled
2389
 
                # + secret.
2390
 
                exclude = set(("bus", "changedstate", "secret",
2391
 
                               "checker"))
2392
 
                for name, typ in (inspect.getmembers
2393
 
                                  (dbus.service.Object)):
2394
 
                    exclude.add(name)
2395
 
                
2396
 
                client_dict["encrypted_secret"] = (client
2397
 
                                                   .encrypted_secret)
2398
 
                for attr in client.client_structure:
2399
 
                    if attr not in exclude:
2400
 
                        client_dict[attr] = getattr(client, attr)
2401
 
                
2402
 
                clients[client.name] = client_dict
2403
 
                del client_settings[client.name]["secret"]
2404
 
        
2405
 
        try:
2406
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2407
 
                                                prefix="clients-",
2408
 
                                                dir=os.path.dirname
2409
 
                                                (stored_state_path))
2410
 
            with os.fdopen(tempfd, "wb") as stored_state:
2411
 
                pickle.dump((clients, client_settings), stored_state)
2412
 
            os.rename(tempname, stored_state_path)
2413
 
        except (IOError, OSError) as e:
2414
 
            logger.warning("Could not save persistent state: {0}"
2415
 
                           .format(e))
2416
 
            if not debug:
2417
 
                try:
2418
 
                    os.remove(tempname)
2419
 
                except NameError:
2420
 
                    pass
2421
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2422
 
                                   errno.EEXIST)):
2423
 
                raise e
2424
 
        
2425
 
        # Delete all clients, and settings from config
2426
 
        while tcp_server.clients:
2427
 
            name, client = tcp_server.clients.popitem()
2428
 
            if use_dbus:
2429
 
                client.remove_from_connection()
2430
 
            # Don't signal anything except ClientRemoved
2431
 
            client.disable(quiet=True)
2432
 
            if use_dbus:
2433
 
                # Emit D-Bus signal
2434
 
                mandos_dbus_service.ClientRemoved(client
2435
 
                                                  .dbus_object_path,
2436
 
                                                  client.name)
2437
 
        client_settings.clear()
2438
 
    
2439
 
    atexit.register(cleanup)
2440
 
    
2441
 
    for client in tcp_server.clients.itervalues():
2442
 
        if use_dbus:
2443
 
            # Emit D-Bus signal
2444
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2445
 
        # Need to initiate checking of clients
2446
 
        if client.enabled:
2447
 
            client.init_checker()
2448
 
    
2449
 
    tcp_server.enable()
2450
 
    tcp_server.server_activate()
2451
 
    
 
787
    for client in clients:
 
788
        client.start()
 
789
    
 
790
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
791
                                 server_settings["port"]),
 
792
                                tcp_handler,
 
793
                                settings=server_settings,
 
794
                                clients=clients)
2452
795
    # Find out what port we got
2453
796
    service.port = tcp_server.socket.getsockname()[1]
2454
 
    if use_ipv6:
2455
 
        logger.info("Now listening on address %r, port %d,"
2456
 
                    " flowinfo %d, scope_id %d"
2457
 
                    % tcp_server.socket.getsockname())
2458
 
    else:                       # IPv4
2459
 
        logger.info("Now listening on address %r, port %d"
2460
 
                    % tcp_server.socket.getsockname())
 
797
    logger.debug(u"Now listening on port %d", service.port)
2461
798
    
2462
 
    #service.interface = tcp_server.socket.getsockname()[3]
 
799
    if not server_settings["interface"]:
 
800
        service.interface = if_nametoindex\
 
801
                            (server_settings["interface"])
2463
802
    
2464
803
    try:
2465
804
        # From the Avahi example code
 
805
        server.connect_to_signal("StateChanged", server_state_changed)
2466
806
        try:
2467
 
            service.activate()
2468
 
        except dbus.exceptions.DBusException as error:
2469
 
            logger.critical("DBusException: %s", error)
2470
 
            cleanup()
 
807
            server_state_changed(server.GetState())
 
808
        except dbus.exceptions.DBusException, error:
 
809
            logger.critical(u"DBusException: %s", error)
2471
810
            sys.exit(1)
2472
811
        # End of Avahi example code
2473
812
        
2474
813
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2475
814
                             lambda *args, **kwargs:
2476
 
                             (tcp_server.handle_request
2477
 
                              (*args[2:], **kwargs) or True))
 
815
                             tcp_server.handle_request\
 
816
                             (*args[2:], **kwargs) or True)
2478
817
        
2479
818
        logger.debug("Starting main loop")
 
819
        main_loop_started = True
2480
820
        main_loop.run()
2481
 
    except AvahiError as error:
2482
 
        logger.critical("AvahiError: %s", error)
2483
 
        cleanup()
 
821
    except AvahiError, error:
 
822
        logger.critical(u"AvahiError: %s" + unicode(error))
2484
823
        sys.exit(1)
2485
824
    except KeyboardInterrupt:
2486
825
        if debug:
2487
 
            print("", file=sys.stderr)
2488
 
        logger.debug("Server received KeyboardInterrupt")
2489
 
    logger.debug("Server exiting")
2490
 
    # Must run before the D-Bus bus name gets deregistered
2491
 
    cleanup()
 
826
            print
2492
827
 
2493
828
if __name__ == '__main__':
2494
829
    main()