/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2012-01-01 17:38:33 UTC
  • Revision ID: teddy@recompile.se-20120101173833-ai39bif1w0ftuyyh
* Makefile (install-server): Add intro(8mandos) man page.
* network-hooks.d/bridge: Add copyright info and year.
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -

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