/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2011-04-02 06:37:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110402063718-13ldrcuu0t33sdc4
* mandos: Tolerate restarting Avahi servers.  Also Changed to new
          "except x as y" exception syntax.
  (AvahiService.entry_group_state_changed_match): New; contains the
                                                  SignalMatch object.
  (AvahiService.remove): Really remove the group and the signal
                         connection, if any.
  (AvahiService.add): Always create a new group and signal connection.
  (AvahiService.cleanup): Changed to simply call remove().
  (AvahiService.server_state_changed): Handle and log more bad states.
  (AvahiService.activate): Set "follow_name_owner_changes=True" on the
                           Avahi Server proxy object.
  (ClientDBus.checked_ok): Do not return anything.
  (ClientDBus.CheckedOK): Do not return anything, as documented.
* mandos-monitor: Call D-Bus methods asynchronously.

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 © 2008 Teddy Hogeborn
15
 
# Copyright © 2008 Björn Påhlsson
 
14
# Copyright © 2008-2011 Teddy Hogeborn
 
15
# Copyright © 2008-2011 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
31
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
33
33
 
34
 
from __future__ import division, with_statement, absolute_import
 
34
from __future__ import (division, absolute_import, print_function,
 
35
                        unicode_literals)
35
36
 
36
 
import SocketServer
 
37
import SocketServer as socketserver
37
38
import socket
38
 
from optparse import OptionParser
 
39
import argparse
39
40
import datetime
40
41
import errno
41
42
import gnutls.crypto
44
45
import gnutls.library.functions
45
46
import gnutls.library.constants
46
47
import gnutls.library.types
47
 
import ConfigParser
 
48
import ConfigParser as configparser
48
49
import sys
49
50
import re
50
51
import os
51
52
import signal
52
 
from sets import Set
53
53
import subprocess
54
54
import atexit
55
55
import stat
56
56
import logging
57
57
import logging.handlers
58
58
import pwd
59
 
from contextlib import closing
 
59
import contextlib
 
60
import struct
 
61
import fcntl
 
62
import functools
 
63
import cPickle as pickle
 
64
import multiprocessing
60
65
 
61
66
import dbus
62
67
import dbus.service
65
70
from dbus.mainloop.glib import DBusGMainLoop
66
71
import ctypes
67
72
import ctypes.util
68
 
 
69
 
version = "1.0.2"
70
 
 
 
73
import xml.dom.minidom
 
74
import inspect
 
75
 
 
76
try:
 
77
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
 
78
except AttributeError:
 
79
    try:
 
80
        from IN import SO_BINDTODEVICE
 
81
    except ImportError:
 
82
        SO_BINDTODEVICE = None
 
83
 
 
84
 
 
85
version = "1.3.0"
 
86
 
 
87
#logger = logging.getLogger('mandos')
71
88
logger = logging.Logger('mandos')
72
89
syslogger = (logging.handlers.SysLogHandler
73
90
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
74
 
              address = "/dev/log"))
 
91
              address = str("/dev/log")))
75
92
syslogger.setFormatter(logging.Formatter
76
 
                       ('Mandos: %(levelname)s: %(message)s'))
 
93
                       ('Mandos [%(process)d]: %(levelname)s:'
 
94
                        ' %(message)s'))
77
95
logger.addHandler(syslogger)
78
96
 
79
97
console = logging.StreamHandler()
80
 
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
 
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
 
99
                                       ' %(levelname)s:'
81
100
                                       ' %(message)s'))
82
101
logger.addHandler(console)
83
102
 
84
103
class AvahiError(Exception):
85
 
    def __init__(self, value):
 
104
    def __init__(self, value, *args, **kwargs):
86
105
        self.value = value
87
 
        super(AvahiError, self).__init__()
88
 
    def __str__(self):
89
 
        return repr(self.value)
 
106
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
107
    def __unicode__(self):
 
108
        return unicode(repr(self.value))
90
109
 
91
110
class AvahiServiceError(AvahiError):
92
111
    pass
97
116
 
98
117
class AvahiService(object):
99
118
    """An Avahi (Zeroconf) service.
 
119
    
100
120
    Attributes:
101
121
    interface: integer; avahi.IF_UNSPEC or an interface index.
102
122
               Used to optionally bind to the specified interface.
110
130
    max_renames: integer; maximum number of renames
111
131
    rename_count: integer; counter so we only rename after collisions
112
132
                  a sensible number of times
 
133
    group: D-Bus Entry Group
 
134
    server: D-Bus Server
 
135
    bus: dbus.SystemBus()
113
136
    """
114
137
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
138
                 servicetype = None, port = None, TXT = None,
116
 
                 domain = "", host = "", max_renames = 32768):
 
139
                 domain = "", host = "", max_renames = 32768,
 
140
                 protocol = avahi.PROTO_UNSPEC, bus = None):
117
141
        self.interface = interface
118
142
        self.name = name
119
143
        self.type = servicetype
123
147
        self.host = host
124
148
        self.rename_count = 0
125
149
        self.max_renames = max_renames
 
150
        self.protocol = protocol
 
151
        self.group = None       # our entry group
 
152
        self.server = None
 
153
        self.bus = bus
 
154
        self.entry_group_state_changed_match = None
126
155
    def rename(self):
127
156
        """Derived from the Avahi example code"""
128
157
        if self.rename_count >= self.max_renames:
129
 
            logger.critical(u"No suitable Zeroconf service name found"
130
 
                            u" after %i retries, exiting.",
 
158
            logger.critical("No suitable Zeroconf service name found"
 
159
                            " after %i retries, exiting.",
131
160
                            self.rename_count)
132
161
            raise AvahiServiceError("Too many renames")
133
 
        self.name = server.GetAlternativeServiceName(self.name)
134
 
        logger.info(u"Changing Zeroconf service name to %r ...",
135
 
                    str(self.name))
 
162
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
 
163
        logger.info("Changing Zeroconf service name to %r ...",
 
164
                    self.name)
136
165
        syslogger.setFormatter(logging.Formatter
137
 
                               ('Mandos (%s): %%(levelname)s:'
138
 
                                ' %%(message)s' % self.name))
 
166
                               ('Mandos (%s) [%%(process)d]:'
 
167
                                ' %%(levelname)s: %%(message)s'
 
168
                                % self.name))
139
169
        self.remove()
140
 
        self.add()
 
170
        try:
 
171
            self.add()
 
172
        except dbus.exceptions.DBusException as error:
 
173
            logger.critical("DBusException: %s", error)
 
174
            self.cleanup()
 
175
            os._exit(1)
141
176
        self.rename_count += 1
142
177
    def remove(self):
143
178
        """Derived from the Avahi example code"""
144
 
        if group is not None:
145
 
            group.Reset()
 
179
        if self.group is not None:
 
180
            try:
 
181
                self.group.Free()
 
182
            except (dbus.exceptions.UnknownMethodException,
 
183
                    dbus.exceptions.DBusException) as e:
 
184
                pass
 
185
            self.group = None
 
186
        if self.entry_group_state_changed_match is not None:
 
187
            self.entry_group_state_changed_match.remove()
 
188
            self.entry_group_state_changed_match = None
146
189
    def add(self):
147
190
        """Derived from the Avahi example code"""
148
 
        global group
149
 
        if group is None:
150
 
            group = dbus.Interface(bus.get_object
151
 
                                   (avahi.DBUS_NAME,
152
 
                                    server.EntryGroupNew()),
153
 
                                   avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
 
            group.connect_to_signal('StateChanged',
155
 
                                    entry_group_state_changed)
156
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
157
 
                     service.name, service.type)
158
 
        group.AddService(
159
 
                self.interface,         # interface
160
 
                avahi.PROTO_INET6,      # protocol
161
 
                dbus.UInt32(0),         # flags
162
 
                self.name, self.type,
163
 
                self.domain, self.host,
164
 
                dbus.UInt16(self.port),
165
 
                avahi.string_array_to_txt_array(self.TXT))
166
 
        group.Commit()
167
 
 
168
 
# From the Avahi example code:
169
 
group = None                            # our entry group
170
 
# End of Avahi example code
171
 
 
172
 
 
173
 
class Client(dbus.service.Object):
 
191
        self.remove()
 
192
        self.group = dbus.Interface(
 
193
            self.bus.get_object(avahi.DBUS_NAME,
 
194
                                self.server.EntryGroupNew(),
 
195
                                follow_name_owner_changes=True),
 
196
            avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
197
        self.entry_group_state_changed_match = (
 
198
            self.group.connect_to_signal(
 
199
                'StateChanged', self .entry_group_state_changed))
 
200
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
201
                     self.name, self.type)
 
202
        self.group.AddService(
 
203
            self.interface,
 
204
            self.protocol,
 
205
            dbus.UInt32(0),     # flags
 
206
            self.name, self.type,
 
207
            self.domain, self.host,
 
208
            dbus.UInt16(self.port),
 
209
            avahi.string_array_to_txt_array(self.TXT))
 
210
        self.group.Commit()
 
211
    def entry_group_state_changed(self, state, error):
 
212
        """Derived from the Avahi example code"""
 
213
        logger.debug("Avahi entry group state change: %i", state)
 
214
        
 
215
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
216
            logger.debug("Zeroconf service established.")
 
217
        elif state == avahi.ENTRY_GROUP_COLLISION:
 
218
            logger.info("Zeroconf service name collision.")
 
219
            self.rename()
 
220
        elif state == avahi.ENTRY_GROUP_FAILURE:
 
221
            logger.critical("Avahi: Error in group state changed %s",
 
222
                            unicode(error))
 
223
            raise AvahiGroupError("State changed: %s"
 
224
                                  % unicode(error))
 
225
    def cleanup(self):
 
226
        """Derived from the Avahi example code"""
 
227
        self.remove()
 
228
    def server_state_changed(self, state, error=None):
 
229
        """Derived from the Avahi example code"""
 
230
        logger.debug("Avahi server state change: %i", state)
 
231
        bad_states = { avahi.SERVER_INVALID:
 
232
                           "Zeroconf server invalid",
 
233
                       avahi.SERVER_REGISTERING: None,
 
234
                       avahi.SERVER_COLLISION:
 
235
                           "Zeroconf server name collision",
 
236
                       avahi.SERVER_FAILURE:
 
237
                           "Zeroconf server failure" }
 
238
        if state in bad_states:
 
239
            if bad_states[state]:
 
240
                logger.error(bad_states[state])
 
241
            self.remove()
 
242
        elif state == avahi.SERVER_RUNNING:
 
243
            self.add()
 
244
        else:
 
245
            logger.debug("Unknown state: %r", state)
 
246
    def activate(self):
 
247
        """Derived from the Avahi example code"""
 
248
        if self.server is None:
 
249
            self.server = dbus.Interface(
 
250
                self.bus.get_object(avahi.DBUS_NAME,
 
251
                                    avahi.DBUS_PATH_SERVER,
 
252
                                    follow_name_owner_changes=True),
 
253
                avahi.DBUS_INTERFACE_SERVER)
 
254
        self.server.connect_to_signal("StateChanged",
 
255
                                 self.server_state_changed)
 
256
        self.server_state_changed(self.server.GetState())
 
257
 
 
258
 
 
259
class Client(object):
174
260
    """A representation of a client host served by this server.
 
261
    
175
262
    Attributes:
176
 
    name:      string; from the config file, used in log messages
 
263
    _approved:   bool(); 'None' if not yet approved/disapproved
 
264
    approval_delay: datetime.timedelta(); Time to wait for approval
 
265
    approval_duration: datetime.timedelta(); Duration of one approval
 
266
    checker:    subprocess.Popen(); a running checker process used
 
267
                                    to see if the client lives.
 
268
                                    'None' if no process is running.
 
269
    checker_callback_tag: a gobject event source tag, or None
 
270
    checker_command: string; External command which is run to check
 
271
                     if client lives.  %() expansions are done at
 
272
                     runtime with vars(self) as dict, so that for
 
273
                     instance %(name)s can be used in the command.
 
274
    checker_initiator_tag: a gobject event source tag, or None
 
275
    created:    datetime.datetime(); (UTC) object creation
 
276
    current_checker_command: string; current running checker_command
 
277
    disable_hook:  If set, called by disable() as disable_hook(self)
 
278
    disable_initiator_tag: a gobject event source tag, or None
 
279
    enabled:    bool()
177
280
    fingerprint: string (40 or 32 hexadecimal digits); used to
178
281
                 uniquely identify the client
179
 
    secret:    bytestring; sent verbatim (over TLS) to client
180
 
    host:      string; available for use by the checker command
181
 
    created:   datetime.datetime(); (UTC) object creation
182
 
    started:   datetime.datetime(); (UTC) last started
 
282
    host:       string; available for use by the checker command
 
283
    interval:   datetime.timedelta(); How often to start a new checker
 
284
    last_approval_request: datetime.datetime(); (UTC) or None
183
285
    last_checked_ok: datetime.datetime(); (UTC) or None
184
 
    timeout:   datetime.timedelta(); How long from last_checked_ok
185
 
                                     until this client is invalid
186
 
    interval:  datetime.timedelta(); How often to start a new checker
187
 
    stop_hook: If set, called by stop() as stop_hook(self)
188
 
    checker:   subprocess.Popen(); a running checker process used
189
 
                                   to see if the client lives.
190
 
                                   'None' if no process is running.
191
 
    checker_initiator_tag: a gobject event source tag, or None
192
 
    stop_initiator_tag:    - '' -
193
 
    checker_callback_tag:  - '' -
194
 
    checker_command: string; External command which is run to check if
195
 
                     client lives.  %() expansions are done at
196
 
                     runtime with vars(self) as dict, so that for
197
 
                     instance %(name)s can be used in the command.
198
 
    Private attibutes:
199
 
    _timeout: Real variable for 'timeout'
200
 
    _interval: Real variable for 'interval'
201
 
    _timeout_milliseconds: Used when calling gobject.timeout_add()
202
 
    _interval_milliseconds: - '' -
 
286
    last_enabled: datetime.datetime(); (UTC)
 
287
    name:       string; from the config file, used in log messages and
 
288
                        D-Bus identifiers
 
289
    secret:     bytestring; sent verbatim (over TLS) to client
 
290
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
291
                                      until this client is disabled
 
292
    runtime_expansions: Allowed attributes for runtime expansion.
203
293
    """
204
 
    def _set_timeout(self, timeout):
205
 
        "Setter function for the 'timeout' attribute"
206
 
        self._timeout = timeout
207
 
        self._timeout_milliseconds = ((self.timeout.days
208
 
                                       * 24 * 60 * 60 * 1000)
209
 
                                      + (self.timeout.seconds * 1000)
210
 
                                      + (self.timeout.microseconds
211
 
                                         // 1000))
212
 
        # Emit D-Bus signal
213
 
        self.TimeoutChanged(self._timeout_milliseconds)
214
 
    timeout = property(lambda self: self._timeout, _set_timeout)
215
 
    del _set_timeout
216
 
    
217
 
    def _set_interval(self, interval):
218
 
        "Setter function for the 'interval' attribute"
219
 
        self._interval = interval
220
 
        self._interval_milliseconds = ((self.interval.days
221
 
                                        * 24 * 60 * 60 * 1000)
222
 
                                       + (self.interval.seconds
223
 
                                          * 1000)
224
 
                                       + (self.interval.microseconds
225
 
                                          // 1000))
226
 
        # Emit D-Bus signal
227
 
        self.IntervalChanged(self._interval_milliseconds)
228
 
    interval = property(lambda self: self._interval, _set_interval)
229
 
    del _set_interval
230
 
    
231
 
    def __init__(self, name = None, stop_hook=None, config=None):
 
294
    
 
295
    runtime_expansions = ("approval_delay", "approval_duration",
 
296
                          "created", "enabled", "fingerprint",
 
297
                          "host", "interval", "last_checked_ok",
 
298
                          "last_enabled", "name", "timeout")
 
299
    
 
300
    @staticmethod
 
301
    def _timedelta_to_milliseconds(td):
 
302
        "Convert a datetime.timedelta() to milliseconds"
 
303
        return ((td.days * 24 * 60 * 60 * 1000)
 
304
                + (td.seconds * 1000)
 
305
                + (td.microseconds // 1000))
 
306
    
 
307
    def timeout_milliseconds(self):
 
308
        "Return the 'timeout' attribute in milliseconds"
 
309
        return self._timedelta_to_milliseconds(self.timeout)
 
310
    
 
311
    def interval_milliseconds(self):
 
312
        "Return the 'interval' attribute in milliseconds"
 
313
        return self._timedelta_to_milliseconds(self.interval)
 
314
 
 
315
    def approval_delay_milliseconds(self):
 
316
        return self._timedelta_to_milliseconds(self.approval_delay)
 
317
    
 
318
    def __init__(self, name = None, disable_hook=None, config=None):
232
319
        """Note: the 'checker' key in 'config' sets the
233
320
        'checker_command' attribute and *not* the 'checker'
234
321
        attribute."""
235
 
        dbus.service.Object.__init__(self, bus,
236
 
                                     "/Mandos/clients/%s"
237
 
                                     % name.replace(".", "_"))
 
322
        self.name = name
238
323
        if config is None:
239
324
            config = {}
240
 
        self.name = name
241
 
        logger.debug(u"Creating client %r", self.name)
 
325
        logger.debug("Creating client %r", self.name)
242
326
        # Uppercase and remove spaces from fingerprint for later
243
327
        # comparison purposes with return value from the fingerprint()
244
328
        # function
245
329
        self.fingerprint = (config["fingerprint"].upper()
246
 
                            .replace(u" ", u""))
247
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
 
330
                            .replace(" ", ""))
 
331
        logger.debug("  Fingerprint: %s", self.fingerprint)
248
332
        if "secret" in config:
249
 
            self.secret = config["secret"].decode(u"base64")
 
333
            self.secret = config["secret"].decode("base64")
250
334
        elif "secfile" in config:
251
 
            with closing(open(os.path.expanduser
252
 
                              (os.path.expandvars
253
 
                               (config["secfile"])))) as secfile:
 
335
            with open(os.path.expanduser(os.path.expandvars
 
336
                                         (config["secfile"])),
 
337
                      "rb") as secfile:
254
338
                self.secret = secfile.read()
255
339
        else:
256
 
            raise TypeError(u"No secret or secfile for client %s"
 
340
            raise TypeError("No secret or secfile for client %s"
257
341
                            % self.name)
258
342
        self.host = config.get("host", "")
259
343
        self.created = datetime.datetime.utcnow()
260
 
        self.started = None
 
344
        self.enabled = False
 
345
        self.last_approval_request = None
 
346
        self.last_enabled = None
261
347
        self.last_checked_ok = None
262
348
        self.timeout = string_to_delta(config["timeout"])
263
349
        self.interval = string_to_delta(config["interval"])
264
 
        self.stop_hook = stop_hook
 
350
        self.disable_hook = disable_hook
265
351
        self.checker = None
266
352
        self.checker_initiator_tag = None
267
 
        self.stop_initiator_tag = None
 
353
        self.disable_initiator_tag = None
268
354
        self.checker_callback_tag = None
269
 
        self.check_command = config["checker"]
 
355
        self.checker_command = config["checker"]
 
356
        self.current_checker_command = None
 
357
        self.last_connect = None
 
358
        self._approved = None
 
359
        self.approved_by_default = config.get("approved_by_default",
 
360
                                              True)
 
361
        self.approvals_pending = 0
 
362
        self.approval_delay = string_to_delta(
 
363
            config["approval_delay"])
 
364
        self.approval_duration = string_to_delta(
 
365
            config["approval_duration"])
 
366
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
270
367
    
271
 
    def start(self):
 
368
    def send_changedstate(self):
 
369
        self.changedstate.acquire()
 
370
        self.changedstate.notify_all()
 
371
        self.changedstate.release()
 
372
        
 
373
    def enable(self):
272
374
        """Start this client's checker and timeout hooks"""
273
 
        self.started = datetime.datetime.utcnow()
 
375
        if getattr(self, "enabled", False):
 
376
            # Already enabled
 
377
            return
 
378
        self.send_changedstate()
 
379
        self.last_enabled = datetime.datetime.utcnow()
274
380
        # Schedule a new checker to be started an 'interval' from now,
275
381
        # and every interval from then on.
276
382
        self.checker_initiator_tag = (gobject.timeout_add
277
 
                                      (self._interval_milliseconds,
 
383
                                      (self.interval_milliseconds(),
278
384
                                       self.start_checker))
 
385
        # Schedule a disable() when 'timeout' has passed
 
386
        self.disable_initiator_tag = (gobject.timeout_add
 
387
                                   (self.timeout_milliseconds(),
 
388
                                    self.disable))
 
389
        self.enabled = True
279
390
        # Also start a new checker *right now*.
280
391
        self.start_checker()
281
 
        # Schedule a stop() when 'timeout' has passed
282
 
        self.stop_initiator_tag = (gobject.timeout_add
283
 
                                   (self._timeout_milliseconds,
284
 
                                    self.stop))
285
 
        # Emit D-Bus signal
286
 
        self.StateChanged(True)
287
392
    
288
 
    def stop(self):
289
 
        """Stop this client."""
290
 
        if getattr(self, "started", None) is not None:
291
 
            logger.info(u"Stopping client %s", self.name)
292
 
        else:
 
393
    def disable(self, quiet=True):
 
394
        """Disable this client."""
 
395
        if not getattr(self, "enabled", False):
293
396
            return False
294
 
        if getattr(self, "stop_initiator_tag", False):
295
 
            gobject.source_remove(self.stop_initiator_tag)
296
 
            self.stop_initiator_tag = None
 
397
        if not quiet:
 
398
            self.send_changedstate()
 
399
        if not quiet:
 
400
            logger.info("Disabling client %s", self.name)
 
401
        if getattr(self, "disable_initiator_tag", False):
 
402
            gobject.source_remove(self.disable_initiator_tag)
 
403
            self.disable_initiator_tag = None
297
404
        if getattr(self, "checker_initiator_tag", False):
298
405
            gobject.source_remove(self.checker_initiator_tag)
299
406
            self.checker_initiator_tag = None
300
407
        self.stop_checker()
301
 
        if self.stop_hook:
302
 
            self.stop_hook(self)
303
 
        self.started = None
304
 
        # Emit D-Bus signal
305
 
        self.StateChanged(False)
 
408
        if self.disable_hook:
 
409
            self.disable_hook(self)
 
410
        self.enabled = False
306
411
        # Do not run this again if called by a gobject.timeout_add
307
412
        return False
308
413
    
309
414
    def __del__(self):
310
 
        self.stop_hook = None
311
 
        self.stop()
 
415
        self.disable_hook = None
 
416
        self.disable()
312
417
    
313
 
    def checker_callback(self, pid, condition):
 
418
    def checker_callback(self, pid, condition, command):
314
419
        """The checker has completed, so take appropriate actions."""
315
420
        self.checker_callback_tag = None
316
421
        self.checker = None
317
 
        if (os.WIFEXITED(condition) 
318
 
            and (os.WEXITSTATUS(condition) == 0)):
319
 
            logger.info(u"Checker for %(name)s succeeded",
320
 
                        vars(self))
321
 
            # Emit D-Bus signal
322
 
            self.CheckerCompleted(True)
323
 
            self.bump_timeout()
324
 
        elif not os.WIFEXITED(condition):
325
 
            logger.warning(u"Checker for %(name)s crashed?",
 
422
        if os.WIFEXITED(condition):
 
423
            exitstatus = os.WEXITSTATUS(condition)
 
424
            if exitstatus == 0:
 
425
                logger.info("Checker for %(name)s succeeded",
 
426
                            vars(self))
 
427
                self.checked_ok()
 
428
            else:
 
429
                logger.info("Checker for %(name)s failed",
 
430
                            vars(self))
 
431
        else:
 
432
            logger.warning("Checker for %(name)s crashed?",
326
433
                           vars(self))
327
 
            # Emit D-Bus signal
328
 
            self.CheckerCompleted(False)
329
 
        else:
330
 
            logger.info(u"Checker for %(name)s failed",
331
 
                        vars(self))
332
 
            # Emit D-Bus signal
333
 
            self.CheckerCompleted(False)
334
434
    
335
 
    def bump_timeout(self):
 
435
    def checked_ok(self):
336
436
        """Bump up the timeout for this client.
 
437
        
337
438
        This should only be called when the client has been seen,
338
439
        alive and well.
339
440
        """
340
441
        self.last_checked_ok = datetime.datetime.utcnow()
341
 
        gobject.source_remove(self.stop_initiator_tag)
342
 
        self.stop_initiator_tag = (gobject.timeout_add
343
 
                                   (self._timeout_milliseconds,
344
 
                                    self.stop))
 
442
        gobject.source_remove(self.disable_initiator_tag)
 
443
        self.disable_initiator_tag = (gobject.timeout_add
 
444
                                      (self.timeout_milliseconds(),
 
445
                                       self.disable))
 
446
    
 
447
    def need_approval(self):
 
448
        self.last_approval_request = datetime.datetime.utcnow()
345
449
    
346
450
    def start_checker(self):
347
451
        """Start a new checker subprocess if one is not running.
 
452
        
348
453
        If a checker already exists, leave it running and do
349
454
        nothing."""
350
455
        # The reason for not killing a running checker is that if we
353
458
        # client would inevitably timeout, since no checker would get
354
459
        # a chance to run to completion.  If we instead leave running
355
460
        # checkers alone, the checker would have to take more time
356
 
        # than 'timeout' for the client to be declared invalid, which
357
 
        # is as it should be.
 
461
        # than 'timeout' for the client to be disabled, which is as it
 
462
        # should be.
 
463
        
 
464
        # If a checker exists, make sure it is not a zombie
 
465
        try:
 
466
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
467
        except (AttributeError, OSError) as error:
 
468
            if (isinstance(error, OSError)
 
469
                and error.errno != errno.ECHILD):
 
470
                raise error
 
471
        else:
 
472
            if pid:
 
473
                logger.warning("Checker was a zombie")
 
474
                gobject.source_remove(self.checker_callback_tag)
 
475
                self.checker_callback(pid, status,
 
476
                                      self.current_checker_command)
 
477
        # Start a new checker if needed
358
478
        if self.checker is None:
359
479
            try:
360
 
                # In case check_command has exactly one % operator
361
 
                command = self.check_command % self.host
 
480
                # In case checker_command has exactly one % operator
 
481
                command = self.checker_command % self.host
362
482
            except TypeError:
363
483
                # Escape attributes for the shell
364
 
                escaped_attrs = dict((key, re.escape(str(val)))
365
 
                                     for key, val in
366
 
                                     vars(self).iteritems())
 
484
                escaped_attrs = dict(
 
485
                    (attr,
 
486
                     re.escape(unicode(str(getattr(self, attr, "")),
 
487
                                       errors=
 
488
                                       'replace')))
 
489
                    for attr in
 
490
                    self.runtime_expansions)
 
491
 
367
492
                try:
368
 
                    command = self.check_command % escaped_attrs
369
 
                except TypeError, error:
370
 
                    logger.error(u'Could not format string "%s":'
371
 
                                 u' %s', self.check_command, error)
 
493
                    command = self.checker_command % escaped_attrs
 
494
                except TypeError as error:
 
495
                    logger.error('Could not format string "%s":'
 
496
                                 ' %s', self.checker_command, error)
372
497
                    return True # Try again later
 
498
            self.current_checker_command = command
373
499
            try:
374
 
                logger.info(u"Starting checker %r for %s",
 
500
                logger.info("Starting checker %r for %s",
375
501
                            command, self.name)
376
502
                # We don't need to redirect stdout and stderr, since
377
503
                # in normal mode, that is already done by daemon(),
382
508
                                                shell=True, cwd="/")
383
509
                self.checker_callback_tag = (gobject.child_watch_add
384
510
                                             (self.checker.pid,
385
 
                                              self.checker_callback))
386
 
                # Emit D-Bus signal
387
 
                self.CheckerStarted(command)
388
 
            except OSError, error:
389
 
                logger.error(u"Failed to start subprocess: %s",
 
511
                                              self.checker_callback,
 
512
                                              data=command))
 
513
                # The checker may have completed before the gobject
 
514
                # watch was added.  Check for this.
 
515
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
516
                if pid:
 
517
                    gobject.source_remove(self.checker_callback_tag)
 
518
                    self.checker_callback(pid, status, command)
 
519
            except OSError as error:
 
520
                logger.error("Failed to start subprocess: %s",
390
521
                             error)
391
522
        # Re-run this periodically if run by gobject.timeout_add
392
523
        return True
398
529
            self.checker_callback_tag = None
399
530
        if getattr(self, "checker", None) is None:
400
531
            return
401
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
532
        logger.debug("Stopping checker for %(name)s", vars(self))
402
533
        try:
403
534
            os.kill(self.checker.pid, signal.SIGTERM)
404
 
            #os.sleep(0.5)
 
535
            #time.sleep(0.5)
405
536
            #if self.checker.poll() is None:
406
537
            #    os.kill(self.checker.pid, signal.SIGKILL)
407
 
        except OSError, error:
 
538
        except OSError as error:
408
539
            if error.errno != errno.ESRCH: # No such process
409
540
                raise
410
541
        self.checker = None
411
 
    
412
 
    def still_valid(self):
413
 
        """Has the timeout not yet passed for this client?"""
414
 
        if not self.started:
415
 
            return False
416
 
        now = datetime.datetime.utcnow()
417
 
        if self.last_checked_ok is None:
418
 
            return now < (self.created + self.timeout)
419
 
        else:
420
 
            return now < (self.last_checked_ok + self.timeout)
421
 
    
422
 
    ## D-Bus methods & signals
423
 
    _interface = u"org.mandos_system.Mandos.Client"
424
 
    
425
 
    def _datetime_to_dbus_struct(dt):
426
 
        return dbus.Struct(dt.year, dt.month, dt.day, dt.hour,
427
 
                           dt.minute, dt.second, dt.microsecond,
428
 
                           signature="nyyyyyu")
429
 
    
430
 
    # BumpTimeout - method
431
 
    BumpTimeout = dbus.service.method(_interface)(bump_timeout)
432
 
    BumpTimeout.__name__ = "BumpTimeout"
433
 
    
434
 
    # IntervalChanged - signal
435
 
    @dbus.service.signal(_interface, signature="t")
436
 
    def IntervalChanged(self, t):
437
 
        "D-Bus signal"
438
 
        pass
 
542
 
 
543
def dbus_service_property(dbus_interface, signature="v",
 
544
                          access="readwrite", byte_arrays=False):
 
545
    """Decorators for marking methods of a DBusObjectWithProperties to
 
546
    become properties on the D-Bus.
 
547
    
 
548
    The decorated method will be called with no arguments by "Get"
 
549
    and with one argument by "Set".
 
550
    
 
551
    The parameters, where they are supported, are the same as
 
552
    dbus.service.method, except there is only "signature", since the
 
553
    type from Get() and the type sent to Set() is the same.
 
554
    """
 
555
    # Encoding deeply encoded byte arrays is not supported yet by the
 
556
    # "Set" method, so we fail early here:
 
557
    if byte_arrays and signature != "ay":
 
558
        raise ValueError("Byte arrays not supported for non-'ay'"
 
559
                         " signature %r" % signature)
 
560
    def decorator(func):
 
561
        func._dbus_is_property = True
 
562
        func._dbus_interface = dbus_interface
 
563
        func._dbus_signature = signature
 
564
        func._dbus_access = access
 
565
        func._dbus_name = func.__name__
 
566
        if func._dbus_name.endswith("_dbus_property"):
 
567
            func._dbus_name = func._dbus_name[:-14]
 
568
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
569
        return func
 
570
    return decorator
 
571
 
 
572
 
 
573
class DBusPropertyException(dbus.exceptions.DBusException):
 
574
    """A base class for D-Bus property-related exceptions
 
575
    """
 
576
    def __unicode__(self):
 
577
        return unicode(str(self))
 
578
 
 
579
 
 
580
class DBusPropertyAccessException(DBusPropertyException):
 
581
    """A property's access permissions disallows an operation.
 
582
    """
 
583
    pass
 
584
 
 
585
 
 
586
class DBusPropertyNotFound(DBusPropertyException):
 
587
    """An attempt was made to access a non-existing property.
 
588
    """
 
589
    pass
 
590
 
 
591
 
 
592
class DBusObjectWithProperties(dbus.service.Object):
 
593
    """A D-Bus object with properties.
 
594
 
 
595
    Classes inheriting from this can use the dbus_service_property
 
596
    decorator to expose methods as D-Bus properties.  It exposes the
 
597
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
598
    """
 
599
    
 
600
    @staticmethod
 
601
    def _is_dbus_property(obj):
 
602
        return getattr(obj, "_dbus_is_property", False)
 
603
    
 
604
    def _get_all_dbus_properties(self):
 
605
        """Returns a generator of (name, attribute) pairs
 
606
        """
 
607
        return ((prop._dbus_name, prop)
 
608
                for name, prop in
 
609
                inspect.getmembers(self, self._is_dbus_property))
 
610
    
 
611
    def _get_dbus_property(self, interface_name, property_name):
 
612
        """Returns a bound method if one exists which is a D-Bus
 
613
        property with the specified name and interface.
 
614
        """
 
615
        for name in (property_name,
 
616
                     property_name + "_dbus_property"):
 
617
            prop = getattr(self, name, None)
 
618
            if (prop is None
 
619
                or not self._is_dbus_property(prop)
 
620
                or prop._dbus_name != property_name
 
621
                or (interface_name and prop._dbus_interface
 
622
                    and interface_name != prop._dbus_interface)):
 
623
                continue
 
624
            return prop
 
625
        # No such property
 
626
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
627
                                   + interface_name + "."
 
628
                                   + property_name)
 
629
    
 
630
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
631
                         out_signature="v")
 
632
    def Get(self, interface_name, property_name):
 
633
        """Standard D-Bus property Get() method, see D-Bus standard.
 
634
        """
 
635
        prop = self._get_dbus_property(interface_name, property_name)
 
636
        if prop._dbus_access == "write":
 
637
            raise DBusPropertyAccessException(property_name)
 
638
        value = prop()
 
639
        if not hasattr(value, "variant_level"):
 
640
            return value
 
641
        return type(value)(value, variant_level=value.variant_level+1)
 
642
    
 
643
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
 
644
    def Set(self, interface_name, property_name, value):
 
645
        """Standard D-Bus property Set() method, see D-Bus standard.
 
646
        """
 
647
        prop = self._get_dbus_property(interface_name, property_name)
 
648
        if prop._dbus_access == "read":
 
649
            raise DBusPropertyAccessException(property_name)
 
650
        if prop._dbus_get_args_options["byte_arrays"]:
 
651
            # The byte_arrays option is not supported yet on
 
652
            # signatures other than "ay".
 
653
            if prop._dbus_signature != "ay":
 
654
                raise ValueError
 
655
            value = dbus.ByteArray(''.join(unichr(byte)
 
656
                                           for byte in value))
 
657
        prop(value)
 
658
    
 
659
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
660
                         out_signature="a{sv}")
 
661
    def GetAll(self, interface_name):
 
662
        """Standard D-Bus property GetAll() method, see D-Bus
 
663
        standard.
 
664
 
 
665
        Note: Will not include properties with access="write".
 
666
        """
 
667
        all = {}
 
668
        for name, prop in self._get_all_dbus_properties():
 
669
            if (interface_name
 
670
                and interface_name != prop._dbus_interface):
 
671
                # Interface non-empty but did not match
 
672
                continue
 
673
            # Ignore write-only properties
 
674
            if prop._dbus_access == "write":
 
675
                continue
 
676
            value = prop()
 
677
            if not hasattr(value, "variant_level"):
 
678
                all[name] = value
 
679
                continue
 
680
            all[name] = type(value)(value, variant_level=
 
681
                                    value.variant_level+1)
 
682
        return dbus.Dictionary(all, signature="sv")
 
683
    
 
684
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
685
                         out_signature="s",
 
686
                         path_keyword='object_path',
 
687
                         connection_keyword='connection')
 
688
    def Introspect(self, object_path, connection):
 
689
        """Standard D-Bus method, overloaded to insert property tags.
 
690
        """
 
691
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
692
                                                   connection)
 
693
        try:
 
694
            document = xml.dom.minidom.parseString(xmlstring)
 
695
            def make_tag(document, name, prop):
 
696
                e = document.createElement("property")
 
697
                e.setAttribute("name", name)
 
698
                e.setAttribute("type", prop._dbus_signature)
 
699
                e.setAttribute("access", prop._dbus_access)
 
700
                return e
 
701
            for if_tag in document.getElementsByTagName("interface"):
 
702
                for tag in (make_tag(document, name, prop)
 
703
                            for name, prop
 
704
                            in self._get_all_dbus_properties()
 
705
                            if prop._dbus_interface
 
706
                            == if_tag.getAttribute("name")):
 
707
                    if_tag.appendChild(tag)
 
708
                # Add the names to the return values for the
 
709
                # "org.freedesktop.DBus.Properties" methods
 
710
                if (if_tag.getAttribute("name")
 
711
                    == "org.freedesktop.DBus.Properties"):
 
712
                    for cn in if_tag.getElementsByTagName("method"):
 
713
                        if cn.getAttribute("name") == "Get":
 
714
                            for arg in cn.getElementsByTagName("arg"):
 
715
                                if (arg.getAttribute("direction")
 
716
                                    == "out"):
 
717
                                    arg.setAttribute("name", "value")
 
718
                        elif cn.getAttribute("name") == "GetAll":
 
719
                            for arg in cn.getElementsByTagName("arg"):
 
720
                                if (arg.getAttribute("direction")
 
721
                                    == "out"):
 
722
                                    arg.setAttribute("name", "props")
 
723
            xmlstring = document.toxml("utf-8")
 
724
            document.unlink()
 
725
        except (AttributeError, xml.dom.DOMException,
 
726
                xml.parsers.expat.ExpatError) as error:
 
727
            logger.error("Failed to override Introspection method",
 
728
                         error)
 
729
        return xmlstring
 
730
 
 
731
 
 
732
class ClientDBus(Client, DBusObjectWithProperties):
 
733
    """A Client class using D-Bus
 
734
    
 
735
    Attributes:
 
736
    dbus_object_path: dbus.ObjectPath
 
737
    bus: dbus.SystemBus()
 
738
    """
 
739
    
 
740
    runtime_expansions = (Client.runtime_expansions
 
741
                          + ("dbus_object_path",))
 
742
    
 
743
    # dbus.service.Object doesn't use super(), so we can't either.
 
744
    
 
745
    def __init__(self, bus = None, *args, **kwargs):
 
746
        self._approvals_pending = 0
 
747
        self.bus = bus
 
748
        Client.__init__(self, *args, **kwargs)
 
749
        # Only now, when this client is initialized, can it show up on
 
750
        # the D-Bus
 
751
        client_object_name = unicode(self.name).translate(
 
752
            {ord("."): ord("_"),
 
753
             ord("-"): ord("_")})
 
754
        self.dbus_object_path = (dbus.ObjectPath
 
755
                                 ("/clients/" + client_object_name))
 
756
        DBusObjectWithProperties.__init__(self, self.bus,
 
757
                                          self.dbus_object_path)
 
758
        
 
759
    def _get_approvals_pending(self):
 
760
        return self._approvals_pending
 
761
    def _set_approvals_pending(self, value):
 
762
        old_value = self._approvals_pending
 
763
        self._approvals_pending = value
 
764
        bval = bool(value)
 
765
        if (hasattr(self, "dbus_object_path")
 
766
            and bval is not bool(old_value)):
 
767
            dbus_bool = dbus.Boolean(bval, variant_level=1)
 
768
            self.PropertyChanged(dbus.String("ApprovalPending"),
 
769
                                 dbus_bool)
 
770
 
 
771
    approvals_pending = property(_get_approvals_pending,
 
772
                                 _set_approvals_pending)
 
773
    del _get_approvals_pending, _set_approvals_pending
 
774
    
 
775
    @staticmethod
 
776
    def _datetime_to_dbus(dt, variant_level=0):
 
777
        """Convert a UTC datetime.datetime() to a D-Bus type."""
 
778
        return dbus.String(dt.isoformat(),
 
779
                           variant_level=variant_level)
 
780
    
 
781
    def enable(self):
 
782
        oldstate = getattr(self, "enabled", False)
 
783
        r = Client.enable(self)
 
784
        if oldstate != self.enabled:
 
785
            # Emit D-Bus signals
 
786
            self.PropertyChanged(dbus.String("Enabled"),
 
787
                                 dbus.Boolean(True, variant_level=1))
 
788
            self.PropertyChanged(
 
789
                dbus.String("LastEnabled"),
 
790
                self._datetime_to_dbus(self.last_enabled,
 
791
                                       variant_level=1))
 
792
        return r
 
793
    
 
794
    def disable(self, quiet = False):
 
795
        oldstate = getattr(self, "enabled", False)
 
796
        r = Client.disable(self, quiet=quiet)
 
797
        if not quiet and oldstate != self.enabled:
 
798
            # Emit D-Bus signal
 
799
            self.PropertyChanged(dbus.String("Enabled"),
 
800
                                 dbus.Boolean(False, variant_level=1))
 
801
        return r
 
802
    
 
803
    def __del__(self, *args, **kwargs):
 
804
        try:
 
805
            self.remove_from_connection()
 
806
        except LookupError:
 
807
            pass
 
808
        if hasattr(DBusObjectWithProperties, "__del__"):
 
809
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
 
810
        Client.__del__(self, *args, **kwargs)
 
811
    
 
812
    def checker_callback(self, pid, condition, command,
 
813
                         *args, **kwargs):
 
814
        self.checker_callback_tag = None
 
815
        self.checker = None
 
816
        # Emit D-Bus signal
 
817
        self.PropertyChanged(dbus.String("CheckerRunning"),
 
818
                             dbus.Boolean(False, variant_level=1))
 
819
        if os.WIFEXITED(condition):
 
820
            exitstatus = os.WEXITSTATUS(condition)
 
821
            # Emit D-Bus signal
 
822
            self.CheckerCompleted(dbus.Int16(exitstatus),
 
823
                                  dbus.Int64(condition),
 
824
                                  dbus.String(command))
 
825
        else:
 
826
            # Emit D-Bus signal
 
827
            self.CheckerCompleted(dbus.Int16(-1),
 
828
                                  dbus.Int64(condition),
 
829
                                  dbus.String(command))
 
830
        
 
831
        return Client.checker_callback(self, pid, condition, command,
 
832
                                       *args, **kwargs)
 
833
    
 
834
    def checked_ok(self, *args, **kwargs):
 
835
        Client.checked_ok(self, *args, **kwargs)
 
836
        # Emit D-Bus signal
 
837
        self.PropertyChanged(
 
838
            dbus.String("LastCheckedOK"),
 
839
            (self._datetime_to_dbus(self.last_checked_ok,
 
840
                                    variant_level=1)))
 
841
    
 
842
    def need_approval(self, *args, **kwargs):
 
843
        r = Client.need_approval(self, *args, **kwargs)
 
844
        # Emit D-Bus signal
 
845
        self.PropertyChanged(
 
846
            dbus.String("LastApprovalRequest"),
 
847
            (self._datetime_to_dbus(self.last_approval_request,
 
848
                                    variant_level=1)))
 
849
        return r
 
850
    
 
851
    def start_checker(self, *args, **kwargs):
 
852
        old_checker = self.checker
 
853
        if self.checker is not None:
 
854
            old_checker_pid = self.checker.pid
 
855
        else:
 
856
            old_checker_pid = None
 
857
        r = Client.start_checker(self, *args, **kwargs)
 
858
        # Only if new checker process was started
 
859
        if (self.checker is not None
 
860
            and old_checker_pid != self.checker.pid):
 
861
            # Emit D-Bus signal
 
862
            self.CheckerStarted(self.current_checker_command)
 
863
            self.PropertyChanged(
 
864
                dbus.String("CheckerRunning"),
 
865
                dbus.Boolean(True, variant_level=1))
 
866
        return r
 
867
    
 
868
    def stop_checker(self, *args, **kwargs):
 
869
        old_checker = getattr(self, "checker", None)
 
870
        r = Client.stop_checker(self, *args, **kwargs)
 
871
        if (old_checker is not None
 
872
            and getattr(self, "checker", None) is None):
 
873
            self.PropertyChanged(dbus.String("CheckerRunning"),
 
874
                                 dbus.Boolean(False, variant_level=1))
 
875
        return r
 
876
 
 
877
    def _reset_approved(self):
 
878
        self._approved = None
 
879
        return False
 
880
    
 
881
    def approve(self, value=True):
 
882
        self.send_changedstate()
 
883
        self._approved = value
 
884
        gobject.timeout_add(self._timedelta_to_milliseconds
 
885
                            (self.approval_duration),
 
886
                            self._reset_approved)
 
887
    
 
888
    
 
889
    ## D-Bus methods, signals & properties
 
890
    _interface = "se.bsnet.fukt.Mandos.Client"
 
891
    
 
892
    ## Signals
439
893
    
440
894
    # CheckerCompleted - signal
441
 
    @dbus.service.signal(_interface, signature="b")
442
 
    def CheckerCompleted(self, success):
 
895
    @dbus.service.signal(_interface, signature="nxs")
 
896
    def CheckerCompleted(self, exitcode, waitstatus, command):
443
897
        "D-Bus signal"
444
898
        pass
445
899
    
446
 
    # CheckerIsRunning - method
447
 
    @dbus.service.method(_interface, out_signature="b")
448
 
    def CheckerIsRunning(self):
449
 
        "D-Bus getter method"
450
 
        return self.checker is not None
451
 
    
452
900
    # CheckerStarted - signal
453
901
    @dbus.service.signal(_interface, signature="s")
454
902
    def CheckerStarted(self, command):
455
903
        "D-Bus signal"
456
904
        pass
457
905
    
458
 
    # GetChecker - method
459
 
    @dbus.service.method(_interface, out_signature="s")
460
 
    def GetChecker(self):
461
 
        "D-Bus getter method"
462
 
        return self.checker_command
463
 
    
464
 
    # GetCreated - method
465
 
    @dbus.service.method(_interface, out_signature="(nyyyyyu)")
466
 
    def GetCreated(self):
467
 
        "D-Bus getter method"
468
 
        return datetime_to_dbus_struct(self.created)
469
 
    
470
 
    # GetFingerprint - method
471
 
    @dbus.service.method(_interface, out_signature="s")
472
 
    def GetFingerprint(self):
473
 
        "D-Bus getter method"
474
 
        return self.fingerprint
475
 
    
476
 
    # GetHost - method
477
 
    @dbus.service.method(_interface, out_signature="s")
478
 
    def GetHost(self):
479
 
        "D-Bus getter method"
480
 
        return self.host
481
 
    
482
 
    # GetInterval - method
483
 
    @dbus.service.method(_interface, out_signature="t")
484
 
    def GetInterval(self):
485
 
        "D-Bus getter method"
486
 
        return self._interval_milliseconds
487
 
    
488
 
    # GetName - method
489
 
    @dbus.service.method(_interface, out_signature="s")
490
 
    def GetName(self):
491
 
        "D-Bus getter method"
492
 
        return self.name
493
 
    
494
 
    # GetStarted - method
495
 
    @dbus.service.method(_interface, out_signature="(nyyyyyu)")
496
 
    def GetStarted(self):
497
 
        "D-Bus getter method"
498
 
        if self.started is not None:
499
 
            return datetime_to_dbus_struct(self.started)
500
 
        else:
501
 
            return dbus.Struct(0, 0, 0, 0, 0, 0, 0,
502
 
                               signature="nyyyyyu")
503
 
    
504
 
    # GetTimeout - method
505
 
    @dbus.service.method(_interface, out_signature="t")
506
 
    def GetTimeout(self):
507
 
        "D-Bus getter method"
508
 
        return self._timeout_milliseconds
509
 
    
510
 
    # SetChecker - method
511
 
    @dbus.service.method(_interface, in_signature="s")
512
 
    def SetChecker(self, checker):
513
 
        "D-Bus setter method"
514
 
        self.checker_command = checker
515
 
    
516
 
    # SetHost - method
517
 
    @dbus.service.method(_interface, in_signature="s")
518
 
    def SetHost(self, host):
519
 
        "D-Bus setter method"
520
 
        self.host = host
521
 
    
522
 
    # SetInterval - method
523
 
    @dbus.service.method(_interface, in_signature="t")
524
 
    def SetInterval(self, milliseconds):
525
 
        self.interval = datetime.timdeelta(0, 0, 0, milliseconds)
526
 
    
527
 
    # SetTimeout - method
528
 
    @dbus.service.method(_interface, in_signature="t")
529
 
    def SetTimeout(self, milliseconds):
530
 
        self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
531
 
    
532
 
    # SetSecret - method
533
 
    @dbus.service.method(_interface, in_signature="ay",
534
 
                         byte_arrays=True)
535
 
    def SetSecret(self, secret):
536
 
        "D-Bus setter method"
537
 
        self.secret = str(secret)
538
 
    
539
 
    # Start - method
540
 
    Start = dbus.service.method(_interface)(start)
541
 
    Start.__name__ = "Start"
 
906
    # PropertyChanged - signal
 
907
    @dbus.service.signal(_interface, signature="sv")
 
908
    def PropertyChanged(self, property, value):
 
909
        "D-Bus signal"
 
910
        pass
 
911
    
 
912
    # GotSecret - signal
 
913
    @dbus.service.signal(_interface)
 
914
    def GotSecret(self):
 
915
        """D-Bus signal
 
916
        Is sent after a successful transfer of secret from the Mandos
 
917
        server to mandos-client
 
918
        """
 
919
        pass
 
920
    
 
921
    # Rejected - signal
 
922
    @dbus.service.signal(_interface, signature="s")
 
923
    def Rejected(self, reason):
 
924
        "D-Bus signal"
 
925
        pass
 
926
    
 
927
    # NeedApproval - signal
 
928
    @dbus.service.signal(_interface, signature="tb")
 
929
    def NeedApproval(self, timeout, default):
 
930
        "D-Bus signal"
 
931
        return self.need_approval()
 
932
    
 
933
    ## Methods
 
934
    
 
935
    # Approve - method
 
936
    @dbus.service.method(_interface, in_signature="b")
 
937
    def Approve(self, value):
 
938
        self.approve(value)
 
939
    
 
940
    # CheckedOK - method
 
941
    @dbus.service.method(_interface)
 
942
    def CheckedOK(self):
 
943
        self.checked_ok()
 
944
    
 
945
    # Enable - method
 
946
    @dbus.service.method(_interface)
 
947
    def Enable(self):
 
948
        "D-Bus method"
 
949
        self.enable()
542
950
    
543
951
    # StartChecker - method
544
 
    StartChecker = dbus.service.method(_interface)(start_checker)
545
 
    StartChecker.__name__ = "StartChecker"
546
 
    
547
 
    # StateChanged - signal
548
 
    @dbus.service.signal(_interface, signature="b")
549
 
    def StateChanged(self, started):
550
 
        "D-Bus signal"
551
 
        pass
552
 
    
553
 
    # StillValid - method
554
 
    StillValid = (dbus.service.method(_interface, out_signature="b")
555
 
                  (still_valid))
556
 
    StillValid.__name__ = "StillValid"
557
 
    
558
 
    # Stop - method
559
 
    Stop = dbus.service.method(_interface)(stop)
560
 
    Stop.__name__ = "Stop"
 
952
    @dbus.service.method(_interface)
 
953
    def StartChecker(self):
 
954
        "D-Bus method"
 
955
        self.start_checker()
 
956
    
 
957
    # Disable - method
 
958
    @dbus.service.method(_interface)
 
959
    def Disable(self):
 
960
        "D-Bus method"
 
961
        self.disable()
561
962
    
562
963
    # StopChecker - method
563
 
    StopChecker = dbus.service.method(_interface)(stop_checker)
564
 
    StopChecker.__name__ = "StopChecker"
565
 
    
566
 
    # TimeoutChanged - signal
567
 
    @dbus.service.signal(_interface, signature="t")
568
 
    def TimeoutChanged(self, t):
569
 
        "D-Bus signal"
570
 
        pass
571
 
    
572
 
    del _datetime_to_dbus_struct
 
964
    @dbus.service.method(_interface)
 
965
    def StopChecker(self):
 
966
        self.stop_checker()
 
967
    
 
968
    ## Properties
 
969
    
 
970
    # ApprovalPending - property
 
971
    @dbus_service_property(_interface, signature="b", access="read")
 
972
    def ApprovalPending_dbus_property(self):
 
973
        return dbus.Boolean(bool(self.approvals_pending))
 
974
    
 
975
    # ApprovedByDefault - property
 
976
    @dbus_service_property(_interface, signature="b",
 
977
                           access="readwrite")
 
978
    def ApprovedByDefault_dbus_property(self, value=None):
 
979
        if value is None:       # get
 
980
            return dbus.Boolean(self.approved_by_default)
 
981
        self.approved_by_default = bool(value)
 
982
        # Emit D-Bus signal
 
983
        self.PropertyChanged(dbus.String("ApprovedByDefault"),
 
984
                             dbus.Boolean(value, variant_level=1))
 
985
    
 
986
    # ApprovalDelay - property
 
987
    @dbus_service_property(_interface, signature="t",
 
988
                           access="readwrite")
 
989
    def ApprovalDelay_dbus_property(self, value=None):
 
990
        if value is None:       # get
 
991
            return dbus.UInt64(self.approval_delay_milliseconds())
 
992
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
993
        # Emit D-Bus signal
 
994
        self.PropertyChanged(dbus.String("ApprovalDelay"),
 
995
                             dbus.UInt64(value, variant_level=1))
 
996
    
 
997
    # ApprovalDuration - property
 
998
    @dbus_service_property(_interface, signature="t",
 
999
                           access="readwrite")
 
1000
    def ApprovalDuration_dbus_property(self, value=None):
 
1001
        if value is None:       # get
 
1002
            return dbus.UInt64(self._timedelta_to_milliseconds(
 
1003
                    self.approval_duration))
 
1004
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
1005
        # Emit D-Bus signal
 
1006
        self.PropertyChanged(dbus.String("ApprovalDuration"),
 
1007
                             dbus.UInt64(value, variant_level=1))
 
1008
    
 
1009
    # Name - property
 
1010
    @dbus_service_property(_interface, signature="s", access="read")
 
1011
    def Name_dbus_property(self):
 
1012
        return dbus.String(self.name)
 
1013
    
 
1014
    # Fingerprint - property
 
1015
    @dbus_service_property(_interface, signature="s", access="read")
 
1016
    def Fingerprint_dbus_property(self):
 
1017
        return dbus.String(self.fingerprint)
 
1018
    
 
1019
    # Host - property
 
1020
    @dbus_service_property(_interface, signature="s",
 
1021
                           access="readwrite")
 
1022
    def Host_dbus_property(self, value=None):
 
1023
        if value is None:       # get
 
1024
            return dbus.String(self.host)
 
1025
        self.host = value
 
1026
        # Emit D-Bus signal
 
1027
        self.PropertyChanged(dbus.String("Host"),
 
1028
                             dbus.String(value, variant_level=1))
 
1029
    
 
1030
    # Created - property
 
1031
    @dbus_service_property(_interface, signature="s", access="read")
 
1032
    def Created_dbus_property(self):
 
1033
        return dbus.String(self._datetime_to_dbus(self.created))
 
1034
    
 
1035
    # LastEnabled - property
 
1036
    @dbus_service_property(_interface, signature="s", access="read")
 
1037
    def LastEnabled_dbus_property(self):
 
1038
        if self.last_enabled is None:
 
1039
            return dbus.String("")
 
1040
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
 
1041
    
 
1042
    # Enabled - property
 
1043
    @dbus_service_property(_interface, signature="b",
 
1044
                           access="readwrite")
 
1045
    def Enabled_dbus_property(self, value=None):
 
1046
        if value is None:       # get
 
1047
            return dbus.Boolean(self.enabled)
 
1048
        if value:
 
1049
            self.enable()
 
1050
        else:
 
1051
            self.disable()
 
1052
    
 
1053
    # LastCheckedOK - property
 
1054
    @dbus_service_property(_interface, signature="s",
 
1055
                           access="readwrite")
 
1056
    def LastCheckedOK_dbus_property(self, value=None):
 
1057
        if value is not None:
 
1058
            self.checked_ok()
 
1059
            return
 
1060
        if self.last_checked_ok is None:
 
1061
            return dbus.String("")
 
1062
        return dbus.String(self._datetime_to_dbus(self
 
1063
                                                  .last_checked_ok))
 
1064
    
 
1065
    # LastApprovalRequest - property
 
1066
    @dbus_service_property(_interface, signature="s", access="read")
 
1067
    def LastApprovalRequest_dbus_property(self):
 
1068
        if self.last_approval_request is None:
 
1069
            return dbus.String("")
 
1070
        return dbus.String(self.
 
1071
                           _datetime_to_dbus(self
 
1072
                                             .last_approval_request))
 
1073
    
 
1074
    # Timeout - property
 
1075
    @dbus_service_property(_interface, signature="t",
 
1076
                           access="readwrite")
 
1077
    def Timeout_dbus_property(self, value=None):
 
1078
        if value is None:       # get
 
1079
            return dbus.UInt64(self.timeout_milliseconds())
 
1080
        self.timeout = datetime.timedelta(0, 0, 0, value)
 
1081
        # Emit D-Bus signal
 
1082
        self.PropertyChanged(dbus.String("Timeout"),
 
1083
                             dbus.UInt64(value, variant_level=1))
 
1084
        if getattr(self, "disable_initiator_tag", None) is None:
 
1085
            return
 
1086
        # Reschedule timeout
 
1087
        gobject.source_remove(self.disable_initiator_tag)
 
1088
        self.disable_initiator_tag = None
 
1089
        time_to_die = (self.
 
1090
                       _timedelta_to_milliseconds((self
 
1091
                                                   .last_checked_ok
 
1092
                                                   + self.timeout)
 
1093
                                                  - datetime.datetime
 
1094
                                                  .utcnow()))
 
1095
        if time_to_die <= 0:
 
1096
            # The timeout has passed
 
1097
            self.disable()
 
1098
        else:
 
1099
            self.disable_initiator_tag = (gobject.timeout_add
 
1100
                                          (time_to_die, self.disable))
 
1101
    
 
1102
    # Interval - property
 
1103
    @dbus_service_property(_interface, signature="t",
 
1104
                           access="readwrite")
 
1105
    def Interval_dbus_property(self, value=None):
 
1106
        if value is None:       # get
 
1107
            return dbus.UInt64(self.interval_milliseconds())
 
1108
        self.interval = datetime.timedelta(0, 0, 0, value)
 
1109
        # Emit D-Bus signal
 
1110
        self.PropertyChanged(dbus.String("Interval"),
 
1111
                             dbus.UInt64(value, variant_level=1))
 
1112
        if getattr(self, "checker_initiator_tag", None) is None:
 
1113
            return
 
1114
        # Reschedule checker run
 
1115
        gobject.source_remove(self.checker_initiator_tag)
 
1116
        self.checker_initiator_tag = (gobject.timeout_add
 
1117
                                      (value, self.start_checker))
 
1118
        self.start_checker()    # Start one now, too
 
1119
 
 
1120
    # Checker - property
 
1121
    @dbus_service_property(_interface, signature="s",
 
1122
                           access="readwrite")
 
1123
    def Checker_dbus_property(self, value=None):
 
1124
        if value is None:       # get
 
1125
            return dbus.String(self.checker_command)
 
1126
        self.checker_command = value
 
1127
        # Emit D-Bus signal
 
1128
        self.PropertyChanged(dbus.String("Checker"),
 
1129
                             dbus.String(self.checker_command,
 
1130
                                         variant_level=1))
 
1131
    
 
1132
    # CheckerRunning - property
 
1133
    @dbus_service_property(_interface, signature="b",
 
1134
                           access="readwrite")
 
1135
    def CheckerRunning_dbus_property(self, value=None):
 
1136
        if value is None:       # get
 
1137
            return dbus.Boolean(self.checker is not None)
 
1138
        if value:
 
1139
            self.start_checker()
 
1140
        else:
 
1141
            self.stop_checker()
 
1142
    
 
1143
    # ObjectPath - property
 
1144
    @dbus_service_property(_interface, signature="o", access="read")
 
1145
    def ObjectPath_dbus_property(self):
 
1146
        return self.dbus_object_path # is already a dbus.ObjectPath
 
1147
    
 
1148
    # Secret = property
 
1149
    @dbus_service_property(_interface, signature="ay",
 
1150
                           access="write", byte_arrays=True)
 
1151
    def Secret_dbus_property(self, value):
 
1152
        self.secret = str(value)
 
1153
    
573
1154
    del _interface
574
1155
 
575
1156
 
576
 
def peer_certificate(session):
577
 
    "Return the peer's OpenPGP certificate as a bytestring"
578
 
    # If not an OpenPGP certificate...
579
 
    if (gnutls.library.functions
580
 
        .gnutls_certificate_type_get(session._c_object)
581
 
        != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
582
 
        # ...do the normal thing
583
 
        return session.peer_certificate
584
 
    list_size = ctypes.c_uint()
585
 
    cert_list = (gnutls.library.functions
586
 
                 .gnutls_certificate_get_peers
587
 
                 (session._c_object, ctypes.byref(list_size)))
588
 
    if list_size.value == 0:
589
 
        return None
590
 
    cert = cert_list[0]
591
 
    return ctypes.string_at(cert.data, cert.size)
592
 
 
593
 
 
594
 
def fingerprint(openpgp):
595
 
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
596
 
    # New GnuTLS "datum" with the OpenPGP public key
597
 
    datum = (gnutls.library.types
598
 
             .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
599
 
                                         ctypes.POINTER
600
 
                                         (ctypes.c_ubyte)),
601
 
                             ctypes.c_uint(len(openpgp))))
602
 
    # New empty GnuTLS certificate
603
 
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
604
 
    (gnutls.library.functions
605
 
     .gnutls_openpgp_crt_init(ctypes.byref(crt)))
606
 
    # Import the OpenPGP public key into the certificate
607
 
    (gnutls.library.functions
608
 
     .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
609
 
                                gnutls.library.constants
610
 
                                .GNUTLS_OPENPGP_FMT_RAW))
611
 
    # Verify the self signature in the key
612
 
    crtverify = ctypes.c_uint()
613
 
    (gnutls.library.functions
614
 
     .gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
615
 
    if crtverify.value != 0:
616
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
617
 
        raise gnutls.errors.CertificateSecurityError("Verify failed")
618
 
    # New buffer for the fingerprint
619
 
    buf = ctypes.create_string_buffer(20)
620
 
    buf_len = ctypes.c_size_t()
621
 
    # Get the fingerprint from the certificate into the buffer
622
 
    (gnutls.library.functions
623
 
     .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
624
 
                                         ctypes.byref(buf_len)))
625
 
    # Deinit the certificate
626
 
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
627
 
    # Convert the buffer to a Python bytestring
628
 
    fpr = ctypes.string_at(buf, buf_len.value)
629
 
    # Convert the bytestring to hexadecimal notation
630
 
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
631
 
    return hex_fpr
632
 
 
633
 
 
634
 
class TCP_handler(SocketServer.BaseRequestHandler, object):
635
 
    """A TCP request handler class.
636
 
    Instantiated by IPv6_TCPServer for each request to handle it.
 
1157
class ProxyClient(object):
 
1158
    def __init__(self, child_pipe, fpr, address):
 
1159
        self._pipe = child_pipe
 
1160
        self._pipe.send(('init', fpr, address))
 
1161
        if not self._pipe.recv():
 
1162
            raise KeyError()
 
1163
 
 
1164
    def __getattribute__(self, name):
 
1165
        if(name == '_pipe'):
 
1166
            return super(ProxyClient, self).__getattribute__(name)
 
1167
        self._pipe.send(('getattr', name))
 
1168
        data = self._pipe.recv()
 
1169
        if data[0] == 'data':
 
1170
            return data[1]
 
1171
        if data[0] == 'function':
 
1172
            def func(*args, **kwargs):
 
1173
                self._pipe.send(('funcall', name, args, kwargs))
 
1174
                return self._pipe.recv()[1]
 
1175
            return func
 
1176
 
 
1177
    def __setattr__(self, name, value):
 
1178
        if(name == '_pipe'):
 
1179
            return super(ProxyClient, self).__setattr__(name, value)
 
1180
        self._pipe.send(('setattr', name, value))
 
1181
 
 
1182
 
 
1183
class ClientHandler(socketserver.BaseRequestHandler, object):
 
1184
    """A class to handle client connections.
 
1185
    
 
1186
    Instantiated once for each connection to handle it.
637
1187
    Note: This will run in its own forked process."""
638
1188
    
639
1189
    def handle(self):
640
 
        logger.info(u"TCP connection from: %s",
641
 
                    unicode(self.client_address))
642
 
        session = (gnutls.connection
643
 
                   .ClientSession(self.request,
644
 
                                  gnutls.connection
645
 
                                  .X509Credentials()))
646
 
        
647
 
        line = self.request.makefile().readline()
648
 
        logger.debug(u"Protocol version: %r", line)
649
 
        try:
650
 
            if int(line.strip().split()[0]) > 1:
651
 
                raise RuntimeError
652
 
        except (ValueError, IndexError, RuntimeError), error:
653
 
            logger.error(u"Unknown protocol version: %s", error)
654
 
            return
655
 
        
656
 
        # Note: gnutls.connection.X509Credentials is really a generic
657
 
        # GnuTLS certificate credentials object so long as no X.509
658
 
        # keys are added to it.  Therefore, we can use it here despite
659
 
        # using OpenPGP certificates.
660
 
        
661
 
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
662
 
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
663
 
        #                "+DHE-DSS"))
664
 
        # Use a fallback default, since this MUST be set.
665
 
        priority = self.server.settings.get("priority", "NORMAL")
666
 
        (gnutls.library.functions
667
 
         .gnutls_priority_set_direct(session._c_object,
668
 
                                     priority, None))
669
 
        
670
 
        try:
671
 
            session.handshake()
672
 
        except gnutls.errors.GNUTLSError, error:
673
 
            logger.warning(u"Handshake failed: %s", error)
674
 
            # Do not run session.bye() here: the session is not
675
 
            # established.  Just abandon the request.
676
 
            return
677
 
        try:
678
 
            fpr = fingerprint(peer_certificate(session))
679
 
        except (TypeError, gnutls.errors.GNUTLSError), error:
680
 
            logger.warning(u"Bad certificate: %s", error)
681
 
            session.bye()
682
 
            return
683
 
        logger.debug(u"Fingerprint: %s", fpr)
684
 
        for c in self.server.clients:
685
 
            if c.fingerprint == fpr:
686
 
                client = c
687
 
                break
688
 
        else:
689
 
            logger.warning(u"Client not found for fingerprint: %s",
690
 
                           fpr)
691
 
            session.bye()
692
 
            return
693
 
        # Have to check if client.still_valid(), since it is possible
694
 
        # that the client timed out while establishing the GnuTLS
695
 
        # session.
696
 
        if not client.still_valid():
697
 
            logger.warning(u"Client %(name)s is invalid",
698
 
                           vars(client))
699
 
            session.bye()
700
 
            return
701
 
        ## This won't work here, since we're in a fork.
702
 
        # client.bump_timeout()
703
 
        sent_size = 0
704
 
        while sent_size < len(client.secret):
705
 
            sent = session.send(client.secret[sent_size:])
706
 
            logger.debug(u"Sent: %d, remaining: %d",
707
 
                         sent, len(client.secret)
708
 
                         - (sent_size + sent))
709
 
            sent_size += sent
710
 
        session.bye()
711
 
 
712
 
 
713
 
class IPv6_TCPServer(SocketServer.ForkingMixIn,
714
 
                     SocketServer.TCPServer, object):
715
 
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
 
1190
        with contextlib.closing(self.server.child_pipe) as child_pipe:
 
1191
            logger.info("TCP connection from: %s",
 
1192
                        unicode(self.client_address))
 
1193
            logger.debug("Pipe FD: %d",
 
1194
                         self.server.child_pipe.fileno())
 
1195
 
 
1196
            session = (gnutls.connection
 
1197
                       .ClientSession(self.request,
 
1198
                                      gnutls.connection
 
1199
                                      .X509Credentials()))
 
1200
 
 
1201
            # Note: gnutls.connection.X509Credentials is really a
 
1202
            # generic GnuTLS certificate credentials object so long as
 
1203
            # no X.509 keys are added to it.  Therefore, we can use it
 
1204
            # here despite using OpenPGP certificates.
 
1205
 
 
1206
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
1207
            #                      "+AES-256-CBC", "+SHA1",
 
1208
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
1209
            #                      "+DHE-DSS"))
 
1210
            # Use a fallback default, since this MUST be set.
 
1211
            priority = self.server.gnutls_priority
 
1212
            if priority is None:
 
1213
                priority = "NORMAL"
 
1214
            (gnutls.library.functions
 
1215
             .gnutls_priority_set_direct(session._c_object,
 
1216
                                         priority, None))
 
1217
 
 
1218
            # Start communication using the Mandos protocol
 
1219
            # Get protocol number
 
1220
            line = self.request.makefile().readline()
 
1221
            logger.debug("Protocol version: %r", line)
 
1222
            try:
 
1223
                if int(line.strip().split()[0]) > 1:
 
1224
                    raise RuntimeError
 
1225
            except (ValueError, IndexError, RuntimeError) as error:
 
1226
                logger.error("Unknown protocol version: %s", error)
 
1227
                return
 
1228
 
 
1229
            # Start GnuTLS connection
 
1230
            try:
 
1231
                session.handshake()
 
1232
            except gnutls.errors.GNUTLSError as error:
 
1233
                logger.warning("Handshake failed: %s", error)
 
1234
                # Do not run session.bye() here: the session is not
 
1235
                # established.  Just abandon the request.
 
1236
                return
 
1237
            logger.debug("Handshake succeeded")
 
1238
 
 
1239
            approval_required = False
 
1240
            try:
 
1241
                try:
 
1242
                    fpr = self.fingerprint(self.peer_certificate
 
1243
                                           (session))
 
1244
                except (TypeError,
 
1245
                        gnutls.errors.GNUTLSError) as error:
 
1246
                    logger.warning("Bad certificate: %s", error)
 
1247
                    return
 
1248
                logger.debug("Fingerprint: %s", fpr)
 
1249
 
 
1250
                try:
 
1251
                    client = ProxyClient(child_pipe, fpr,
 
1252
                                         self.client_address)
 
1253
                except KeyError:
 
1254
                    return
 
1255
                
 
1256
                if client.approval_delay:
 
1257
                    delay = client.approval_delay
 
1258
                    client.approvals_pending += 1
 
1259
                    approval_required = True
 
1260
                
 
1261
                while True:
 
1262
                    if not client.enabled:
 
1263
                        logger.warning("Client %s is disabled",
 
1264
                                       client.name)
 
1265
                        if self.server.use_dbus:
 
1266
                            # Emit D-Bus signal
 
1267
                            client.Rejected("Disabled")                    
 
1268
                        return
 
1269
                    
 
1270
                    if client._approved or not client.approval_delay:
 
1271
                        #We are approved or approval is disabled
 
1272
                        break
 
1273
                    elif client._approved is None:
 
1274
                        logger.info("Client %s needs approval",
 
1275
                                    client.name)
 
1276
                        if self.server.use_dbus:
 
1277
                            # Emit D-Bus signal
 
1278
                            client.NeedApproval(
 
1279
                                client.approval_delay_milliseconds(),
 
1280
                                client.approved_by_default)
 
1281
                    else:
 
1282
                        logger.warning("Client %s was not approved",
 
1283
                                       client.name)
 
1284
                        if self.server.use_dbus:
 
1285
                            # Emit D-Bus signal
 
1286
                            client.Rejected("Denied")
 
1287
                        return
 
1288
                    
 
1289
                    #wait until timeout or approved
 
1290
                    #x = float(client._timedelta_to_milliseconds(delay))
 
1291
                    time = datetime.datetime.now()
 
1292
                    client.changedstate.acquire()
 
1293
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1294
                    client.changedstate.release()
 
1295
                    time2 = datetime.datetime.now()
 
1296
                    if (time2 - time) >= delay:
 
1297
                        if not client.approved_by_default:
 
1298
                            logger.warning("Client %s timed out while"
 
1299
                                           " waiting for approval",
 
1300
                                           client.name)
 
1301
                            if self.server.use_dbus:
 
1302
                                # Emit D-Bus signal
 
1303
                                client.Rejected("Approval timed out")
 
1304
                            return
 
1305
                        else:
 
1306
                            break
 
1307
                    else:
 
1308
                        delay -= time2 - time
 
1309
                
 
1310
                sent_size = 0
 
1311
                while sent_size < len(client.secret):
 
1312
                    try:
 
1313
                        sent = session.send(client.secret[sent_size:])
 
1314
                    except gnutls.errors.GNUTLSError as error:
 
1315
                        logger.warning("gnutls send failed")
 
1316
                        return
 
1317
                    logger.debug("Sent: %d, remaining: %d",
 
1318
                                 sent, len(client.secret)
 
1319
                                 - (sent_size + sent))
 
1320
                    sent_size += sent
 
1321
 
 
1322
                logger.info("Sending secret to %s", client.name)
 
1323
                # bump the timeout as if seen
 
1324
                client.checked_ok()
 
1325
                if self.server.use_dbus:
 
1326
                    # Emit D-Bus signal
 
1327
                    client.GotSecret()
 
1328
            
 
1329
            finally:
 
1330
                if approval_required:
 
1331
                    client.approvals_pending -= 1
 
1332
                try:
 
1333
                    session.bye()
 
1334
                except gnutls.errors.GNUTLSError as error:
 
1335
                    logger.warning("GnuTLS bye failed")
 
1336
    
 
1337
    @staticmethod
 
1338
    def peer_certificate(session):
 
1339
        "Return the peer's OpenPGP certificate as a bytestring"
 
1340
        # If not an OpenPGP certificate...
 
1341
        if (gnutls.library.functions
 
1342
            .gnutls_certificate_type_get(session._c_object)
 
1343
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
1344
            # ...do the normal thing
 
1345
            return session.peer_certificate
 
1346
        list_size = ctypes.c_uint(1)
 
1347
        cert_list = (gnutls.library.functions
 
1348
                     .gnutls_certificate_get_peers
 
1349
                     (session._c_object, ctypes.byref(list_size)))
 
1350
        if not bool(cert_list) and list_size.value != 0:
 
1351
            raise gnutls.errors.GNUTLSError("error getting peer"
 
1352
                                            " certificate")
 
1353
        if list_size.value == 0:
 
1354
            return None
 
1355
        cert = cert_list[0]
 
1356
        return ctypes.string_at(cert.data, cert.size)
 
1357
    
 
1358
    @staticmethod
 
1359
    def fingerprint(openpgp):
 
1360
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
 
1361
        # New GnuTLS "datum" with the OpenPGP public key
 
1362
        datum = (gnutls.library.types
 
1363
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1364
                                             ctypes.POINTER
 
1365
                                             (ctypes.c_ubyte)),
 
1366
                                 ctypes.c_uint(len(openpgp))))
 
1367
        # New empty GnuTLS certificate
 
1368
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
1369
        (gnutls.library.functions
 
1370
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
1371
        # Import the OpenPGP public key into the certificate
 
1372
        (gnutls.library.functions
 
1373
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1374
                                    gnutls.library.constants
 
1375
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
1376
        # Verify the self signature in the key
 
1377
        crtverify = ctypes.c_uint()
 
1378
        (gnutls.library.functions
 
1379
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1380
                                         ctypes.byref(crtverify)))
 
1381
        if crtverify.value != 0:
 
1382
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1383
            raise (gnutls.errors.CertificateSecurityError
 
1384
                   ("Verify failed"))
 
1385
        # New buffer for the fingerprint
 
1386
        buf = ctypes.create_string_buffer(20)
 
1387
        buf_len = ctypes.c_size_t()
 
1388
        # Get the fingerprint from the certificate into the buffer
 
1389
        (gnutls.library.functions
 
1390
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1391
                                             ctypes.byref(buf_len)))
 
1392
        # Deinit the certificate
 
1393
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1394
        # Convert the buffer to a Python bytestring
 
1395
        fpr = ctypes.string_at(buf, buf_len.value)
 
1396
        # Convert the bytestring to hexadecimal notation
 
1397
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1398
        return hex_fpr
 
1399
 
 
1400
 
 
1401
class MultiprocessingMixIn(object):
 
1402
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1403
    def sub_process_main(self, request, address):
 
1404
        try:
 
1405
            self.finish_request(request, address)
 
1406
        except:
 
1407
            self.handle_error(request, address)
 
1408
        self.close_request(request)
 
1409
            
 
1410
    def process_request(self, request, address):
 
1411
        """Start a new process to process the request."""
 
1412
        multiprocessing.Process(target = self.sub_process_main,
 
1413
                                args = (request, address)).start()
 
1414
 
 
1415
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
1416
    """ adds a pipe to the MixIn """
 
1417
    def process_request(self, request, client_address):
 
1418
        """Overrides and wraps the original process_request().
 
1419
        
 
1420
        This function creates a new pipe in self.pipe
 
1421
        """
 
1422
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
1423
 
 
1424
        super(MultiprocessingMixInWithPipe,
 
1425
              self).process_request(request, client_address)
 
1426
        self.child_pipe.close()
 
1427
        self.add_pipe(parent_pipe)
 
1428
 
 
1429
    def add_pipe(self, parent_pipe):
 
1430
        """Dummy function; override as necessary"""
 
1431
        raise NotImplementedError
 
1432
 
 
1433
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
 
1434
                     socketserver.TCPServer, object):
 
1435
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
1436
    
716
1437
    Attributes:
717
 
        settings:       Server settings
718
 
        clients:        Set() of Client objects
719
1438
        enabled:        Boolean; whether this server is activated yet
 
1439
        interface:      None or a network interface name (string)
 
1440
        use_ipv6:       Boolean; to use IPv6 or not
720
1441
    """
721
 
    address_family = socket.AF_INET6
722
 
    def __init__(self, *args, **kwargs):
723
 
        if "settings" in kwargs:
724
 
            self.settings = kwargs["settings"]
725
 
            del kwargs["settings"]
726
 
        if "clients" in kwargs:
727
 
            self.clients = kwargs["clients"]
728
 
            del kwargs["clients"]
729
 
        self.enabled = False
730
 
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
 
1442
    def __init__(self, server_address, RequestHandlerClass,
 
1443
                 interface=None, use_ipv6=True):
 
1444
        self.interface = interface
 
1445
        if use_ipv6:
 
1446
            self.address_family = socket.AF_INET6
 
1447
        socketserver.TCPServer.__init__(self, server_address,
 
1448
                                        RequestHandlerClass)
731
1449
    def server_bind(self):
732
1450
        """This overrides the normal server_bind() function
733
1451
        to bind to an interface if one was specified, and also NOT to
734
1452
        bind to an address or port if they were not specified."""
735
 
        if self.settings["interface"]:
736
 
            # 25 is from /usr/include/asm-i486/socket.h
737
 
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
738
 
            try:
739
 
                self.socket.setsockopt(socket.SOL_SOCKET,
740
 
                                       SO_BINDTODEVICE,
741
 
                                       self.settings["interface"])
742
 
            except socket.error, error:
743
 
                if error[0] == errno.EPERM:
744
 
                    logger.error(u"No permission to"
745
 
                                 u" bind to interface %s",
746
 
                                 self.settings["interface"])
747
 
                else:
748
 
                    raise error
 
1453
        if self.interface is not None:
 
1454
            if SO_BINDTODEVICE is None:
 
1455
                logger.error("SO_BINDTODEVICE does not exist;"
 
1456
                             " cannot bind to interface %s",
 
1457
                             self.interface)
 
1458
            else:
 
1459
                try:
 
1460
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1461
                                           SO_BINDTODEVICE,
 
1462
                                           str(self.interface
 
1463
                                               + '\0'))
 
1464
                except socket.error as error:
 
1465
                    if error[0] == errno.EPERM:
 
1466
                        logger.error("No permission to"
 
1467
                                     " bind to interface %s",
 
1468
                                     self.interface)
 
1469
                    elif error[0] == errno.ENOPROTOOPT:
 
1470
                        logger.error("SO_BINDTODEVICE not available;"
 
1471
                                     " cannot bind to interface %s",
 
1472
                                     self.interface)
 
1473
                    else:
 
1474
                        raise
749
1475
        # Only bind(2) the socket if we really need to.
750
1476
        if self.server_address[0] or self.server_address[1]:
751
1477
            if not self.server_address[0]:
752
 
                in6addr_any = "::"
753
 
                self.server_address = (in6addr_any,
 
1478
                if self.address_family == socket.AF_INET6:
 
1479
                    any_address = "::" # in6addr_any
 
1480
                else:
 
1481
                    any_address = socket.INADDR_ANY
 
1482
                self.server_address = (any_address,
754
1483
                                       self.server_address[1])
755
1484
            elif not self.server_address[1]:
756
1485
                self.server_address = (self.server_address[0],
757
1486
                                       0)
758
 
#                 if self.settings["interface"]:
 
1487
#                 if self.interface:
759
1488
#                     self.server_address = (self.server_address[0],
760
1489
#                                            0, # port
761
1490
#                                            0, # flowinfo
762
1491
#                                            if_nametoindex
763
 
#                                            (self.settings
764
 
#                                             ["interface"]))
765
 
            return super(IPv6_TCPServer, self).server_bind()
 
1492
#                                            (self.interface))
 
1493
            return socketserver.TCPServer.server_bind(self)
 
1494
 
 
1495
 
 
1496
class MandosServer(IPv6_TCPServer):
 
1497
    """Mandos server.
 
1498
    
 
1499
    Attributes:
 
1500
        clients:        set of Client objects
 
1501
        gnutls_priority GnuTLS priority string
 
1502
        use_dbus:       Boolean; to emit D-Bus signals or not
 
1503
    
 
1504
    Assumes a gobject.MainLoop event loop.
 
1505
    """
 
1506
    def __init__(self, server_address, RequestHandlerClass,
 
1507
                 interface=None, use_ipv6=True, clients=None,
 
1508
                 gnutls_priority=None, use_dbus=True):
 
1509
        self.enabled = False
 
1510
        self.clients = clients
 
1511
        if self.clients is None:
 
1512
            self.clients = set()
 
1513
        self.use_dbus = use_dbus
 
1514
        self.gnutls_priority = gnutls_priority
 
1515
        IPv6_TCPServer.__init__(self, server_address,
 
1516
                                RequestHandlerClass,
 
1517
                                interface = interface,
 
1518
                                use_ipv6 = use_ipv6)
766
1519
    def server_activate(self):
767
1520
        if self.enabled:
768
 
            return super(IPv6_TCPServer, self).server_activate()
 
1521
            return socketserver.TCPServer.server_activate(self)
769
1522
    def enable(self):
770
1523
        self.enabled = True
 
1524
    def add_pipe(self, parent_pipe):
 
1525
        # Call "handle_ipc" for both data and EOF events
 
1526
        gobject.io_add_watch(parent_pipe.fileno(),
 
1527
                             gobject.IO_IN | gobject.IO_HUP,
 
1528
                             functools.partial(self.handle_ipc,
 
1529
                                               parent_pipe = parent_pipe))
 
1530
        
 
1531
    def handle_ipc(self, source, condition, parent_pipe=None,
 
1532
                   client_object=None):
 
1533
        condition_names = {
 
1534
            gobject.IO_IN: "IN",   # There is data to read.
 
1535
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1536
                                    # blocking).
 
1537
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1538
            gobject.IO_ERR: "ERR", # Error condition.
 
1539
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1540
                                    # broken, usually for pipes and
 
1541
                                    # sockets).
 
1542
            }
 
1543
        conditions_string = ' | '.join(name
 
1544
                                       for cond, name in
 
1545
                                       condition_names.iteritems()
 
1546
                                       if cond & condition)
 
1547
        # error or the other end of multiprocessing.Pipe has closed
 
1548
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
1549
            return False
 
1550
        
 
1551
        # Read a request from the child
 
1552
        request = parent_pipe.recv()
 
1553
        command = request[0]
 
1554
        
 
1555
        if command == 'init':
 
1556
            fpr = request[1]
 
1557
            address = request[2]
 
1558
            
 
1559
            for c in self.clients:
 
1560
                if c.fingerprint == fpr:
 
1561
                    client = c
 
1562
                    break
 
1563
            else:
 
1564
                logger.warning("Client not found for fingerprint: %s, ad"
 
1565
                               "dress: %s", fpr, address)
 
1566
                if self.use_dbus:
 
1567
                    # Emit D-Bus signal
 
1568
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
1569
                parent_pipe.send(False)
 
1570
                return False
 
1571
            
 
1572
            gobject.io_add_watch(parent_pipe.fileno(),
 
1573
                                 gobject.IO_IN | gobject.IO_HUP,
 
1574
                                 functools.partial(self.handle_ipc,
 
1575
                                                   parent_pipe = parent_pipe,
 
1576
                                                   client_object = client))
 
1577
            parent_pipe.send(True)
 
1578
            # remove the old hook in favor of the new above hook on same fileno
 
1579
            return False
 
1580
        if command == 'funcall':
 
1581
            funcname = request[1]
 
1582
            args = request[2]
 
1583
            kwargs = request[3]
 
1584
            
 
1585
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
 
1586
 
 
1587
        if command == 'getattr':
 
1588
            attrname = request[1]
 
1589
            if callable(client_object.__getattribute__(attrname)):
 
1590
                parent_pipe.send(('function',))
 
1591
            else:
 
1592
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
1593
        
 
1594
        if command == 'setattr':
 
1595
            attrname = request[1]
 
1596
            value = request[2]
 
1597
            setattr(client_object, attrname, value)
 
1598
 
 
1599
        return True
771
1600
 
772
1601
 
773
1602
def string_to_delta(interval):
774
1603
    """Parse a string and return a datetime.timedelta
775
 
 
 
1604
    
776
1605
    >>> string_to_delta('7d')
777
1606
    datetime.timedelta(7)
778
1607
    >>> string_to_delta('60s')
781
1610
    datetime.timedelta(0, 3600)
782
1611
    >>> string_to_delta('24h')
783
1612
    datetime.timedelta(1)
784
 
    >>> string_to_delta(u'1w')
 
1613
    >>> string_to_delta('1w')
785
1614
    datetime.timedelta(7)
786
1615
    >>> string_to_delta('5m 30s')
787
1616
    datetime.timedelta(0, 330)
791
1620
        try:
792
1621
            suffix = unicode(s[-1])
793
1622
            value = int(s[:-1])
794
 
            if suffix == u"d":
 
1623
            if suffix == "d":
795
1624
                delta = datetime.timedelta(value)
796
 
            elif suffix == u"s":
 
1625
            elif suffix == "s":
797
1626
                delta = datetime.timedelta(0, value)
798
 
            elif suffix == u"m":
 
1627
            elif suffix == "m":
799
1628
                delta = datetime.timedelta(0, 0, 0, 0, value)
800
 
            elif suffix == u"h":
 
1629
            elif suffix == "h":
801
1630
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
802
 
            elif suffix == u"w":
 
1631
            elif suffix == "w":
803
1632
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
804
1633
            else:
805
 
                raise ValueError
806
 
        except (ValueError, IndexError):
807
 
            raise ValueError
 
1634
                raise ValueError("Unknown suffix %r" % suffix)
 
1635
        except (ValueError, IndexError) as e:
 
1636
            raise ValueError(*(e.args))
808
1637
        timevalue += delta
809
1638
    return timevalue
810
1639
 
811
1640
 
812
 
def server_state_changed(state):
813
 
    """Derived from the Avahi example code"""
814
 
    if state == avahi.SERVER_COLLISION:
815
 
        logger.error(u"Zeroconf server name collision")
816
 
        service.remove()
817
 
    elif state == avahi.SERVER_RUNNING:
818
 
        service.add()
819
 
 
820
 
 
821
 
def entry_group_state_changed(state, error):
822
 
    """Derived from the Avahi example code"""
823
 
    logger.debug(u"Avahi state change: %i", state)
824
 
    
825
 
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
826
 
        logger.debug(u"Zeroconf service established.")
827
 
    elif state == avahi.ENTRY_GROUP_COLLISION:
828
 
        logger.warning(u"Zeroconf service name collision.")
829
 
        service.rename()
830
 
    elif state == avahi.ENTRY_GROUP_FAILURE:
831
 
        logger.critical(u"Avahi: Error in group state changed %s",
832
 
                        unicode(error))
833
 
        raise AvahiGroupError("State changed: %s", str(error))
834
 
 
835
1641
def if_nametoindex(interface):
836
 
    """Call the C function if_nametoindex(), or equivalent"""
 
1642
    """Call the C function if_nametoindex(), or equivalent
 
1643
    
 
1644
    Note: This function cannot accept a unicode string."""
837
1645
    global if_nametoindex
838
1646
    try:
839
1647
        if_nametoindex = (ctypes.cdll.LoadLibrary
840
1648
                          (ctypes.util.find_library("c"))
841
1649
                          .if_nametoindex)
842
1650
    except (OSError, AttributeError):
843
 
        if "struct" not in sys.modules:
844
 
            import struct
845
 
        if "fcntl" not in sys.modules:
846
 
            import fcntl
 
1651
        logger.warning("Doing if_nametoindex the hard way")
847
1652
        def if_nametoindex(interface):
848
1653
            "Get an interface index the hard way, i.e. using fcntl()"
849
1654
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
850
 
            with closing(socket.socket()) as s:
 
1655
            with contextlib.closing(socket.socket()) as s:
851
1656
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
852
 
                                    struct.pack("16s16x", interface))
853
 
            interface_index = struct.unpack("I", ifreq[16:20])[0]
 
1657
                                    struct.pack(str("16s16x"),
 
1658
                                                interface))
 
1659
            interface_index = struct.unpack(str("I"),
 
1660
                                            ifreq[16:20])[0]
854
1661
            return interface_index
855
1662
    return if_nametoindex(interface)
856
1663
 
857
1664
 
858
1665
def daemon(nochdir = False, noclose = False):
859
1666
    """See daemon(3).  Standard BSD Unix function.
 
1667
    
860
1668
    This should really exist as os.daemon, but it doesn't (yet)."""
861
1669
    if os.fork():
862
1670
        sys.exit()
870
1678
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
871
1679
        if not stat.S_ISCHR(os.fstat(null).st_mode):
872
1680
            raise OSError(errno.ENODEV,
873
 
                          "/dev/null not a character device")
 
1681
                          "%s not a character device"
 
1682
                          % os.path.devnull)
874
1683
        os.dup2(null, sys.stdin.fileno())
875
1684
        os.dup2(null, sys.stdout.fileno())
876
1685
        os.dup2(null, sys.stderr.fileno())
879
1688
 
880
1689
 
881
1690
def main():
882
 
    parser = OptionParser(version = "%%prog %s" % version)
883
 
    parser.add_option("-i", "--interface", type="string",
884
 
                      metavar="IF", help="Bind to interface IF")
885
 
    parser.add_option("-a", "--address", type="string",
886
 
                      help="Address to listen for requests on")
887
 
    parser.add_option("-p", "--port", type="int",
888
 
                      help="Port number to receive requests on")
889
 
    parser.add_option("--check", action="store_true", default=False,
890
 
                      help="Run self-test")
891
 
    parser.add_option("--debug", action="store_true",
892
 
                      help="Debug mode; run in foreground and log to"
893
 
                      " terminal")
894
 
    parser.add_option("--priority", type="string", help="GnuTLS"
895
 
                      " priority string (see GnuTLS documentation)")
896
 
    parser.add_option("--servicename", type="string", metavar="NAME",
897
 
                      help="Zeroconf service name")
898
 
    parser.add_option("--configdir", type="string",
899
 
                      default="/etc/mandos", metavar="DIR",
900
 
                      help="Directory to search for configuration"
901
 
                      " files")
902
 
    options = parser.parse_args()[0]
 
1691
    
 
1692
    ##################################################################
 
1693
    # Parsing of options, both command line and config file
 
1694
    
 
1695
    parser = argparse.ArgumentParser()
 
1696
    parser.add_argument("-v", "--version", action="version",
 
1697
                        version = "%%(prog)s %s" % version,
 
1698
                        help="show version number and exit")
 
1699
    parser.add_argument("-i", "--interface", metavar="IF",
 
1700
                        help="Bind to interface IF")
 
1701
    parser.add_argument("-a", "--address",
 
1702
                        help="Address to listen for requests on")
 
1703
    parser.add_argument("-p", "--port", type=int,
 
1704
                        help="Port number to receive requests on")
 
1705
    parser.add_argument("--check", action="store_true",
 
1706
                        help="Run self-test")
 
1707
    parser.add_argument("--debug", action="store_true",
 
1708
                        help="Debug mode; run in foreground and log"
 
1709
                        " to terminal")
 
1710
    parser.add_argument("--debuglevel", metavar="LEVEL",
 
1711
                        help="Debug level for stdout output")
 
1712
    parser.add_argument("--priority", help="GnuTLS"
 
1713
                        " priority string (see GnuTLS documentation)")
 
1714
    parser.add_argument("--servicename",
 
1715
                        metavar="NAME", help="Zeroconf service name")
 
1716
    parser.add_argument("--configdir",
 
1717
                        default="/etc/mandos", metavar="DIR",
 
1718
                        help="Directory to search for configuration"
 
1719
                        " files")
 
1720
    parser.add_argument("--no-dbus", action="store_false",
 
1721
                        dest="use_dbus", help="Do not provide D-Bus"
 
1722
                        " system bus interface")
 
1723
    parser.add_argument("--no-ipv6", action="store_false",
 
1724
                        dest="use_ipv6", help="Do not use IPv6")
 
1725
    options = parser.parse_args()
903
1726
    
904
1727
    if options.check:
905
1728
        import doctest
914
1737
                        "priority":
915
1738
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
916
1739
                        "servicename": "Mandos",
 
1740
                        "use_dbus": "True",
 
1741
                        "use_ipv6": "True",
 
1742
                        "debuglevel": "",
917
1743
                        }
918
1744
    
919
1745
    # Parse config file for server-global settings
920
 
    server_config = ConfigParser.SafeConfigParser(server_defaults)
 
1746
    server_config = configparser.SafeConfigParser(server_defaults)
921
1747
    del server_defaults
922
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
1748
    server_config.read(os.path.join(options.configdir,
 
1749
                                    "mandos.conf"))
923
1750
    # Convert the SafeConfigParser object to a dict
924
1751
    server_settings = server_config.defaults()
925
 
    # Use getboolean on the boolean config option
926
 
    server_settings["debug"] = (server_config.getboolean
927
 
                                ("DEFAULT", "debug"))
 
1752
    # Use the appropriate methods on the non-string config options
 
1753
    for option in ("debug", "use_dbus", "use_ipv6"):
 
1754
        server_settings[option] = server_config.getboolean("DEFAULT",
 
1755
                                                           option)
 
1756
    if server_settings["port"]:
 
1757
        server_settings["port"] = server_config.getint("DEFAULT",
 
1758
                                                       "port")
928
1759
    del server_config
929
1760
    
930
1761
    # Override the settings from the config file with command line
931
1762
    # options, if set.
932
1763
    for option in ("interface", "address", "port", "debug",
933
 
                   "priority", "servicename", "configdir"):
 
1764
                   "priority", "servicename", "configdir",
 
1765
                   "use_dbus", "use_ipv6", "debuglevel"):
934
1766
        value = getattr(options, option)
935
1767
        if value is not None:
936
1768
            server_settings[option] = value
937
1769
    del options
 
1770
    # Force all strings to be unicode
 
1771
    for option in server_settings.keys():
 
1772
        if type(server_settings[option]) is str:
 
1773
            server_settings[option] = unicode(server_settings[option])
938
1774
    # Now we have our good server settings in "server_settings"
939
1775
    
 
1776
    ##################################################################
 
1777
    
 
1778
    # For convenience
940
1779
    debug = server_settings["debug"]
941
 
    
942
 
    if not debug:
943
 
        syslogger.setLevel(logging.WARNING)
944
 
        console.setLevel(logging.WARNING)
945
 
    
 
1780
    debuglevel = server_settings["debuglevel"]
 
1781
    use_dbus = server_settings["use_dbus"]
 
1782
    use_ipv6 = server_settings["use_ipv6"]
 
1783
 
946
1784
    if server_settings["servicename"] != "Mandos":
947
1785
        syslogger.setFormatter(logging.Formatter
948
 
                               ('Mandos (%s): %%(levelname)s:'
949
 
                                ' %%(message)s'
 
1786
                               ('Mandos (%s) [%%(process)d]:'
 
1787
                                ' %%(levelname)s: %%(message)s'
950
1788
                                % server_settings["servicename"]))
951
1789
    
952
1790
    # Parse config file with clients
953
1791
    client_defaults = { "timeout": "1h",
954
1792
                        "interval": "5m",
955
 
                        "checker": "fping -q -- %(host)s",
 
1793
                        "checker": "fping -q -- %%(host)s",
956
1794
                        "host": "",
 
1795
                        "approval_delay": "0s",
 
1796
                        "approval_duration": "1s",
957
1797
                        }
958
 
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
1798
    client_config = configparser.SafeConfigParser(client_defaults)
959
1799
    client_config.read(os.path.join(server_settings["configdir"],
960
1800
                                    "clients.conf"))
961
1801
    
962
 
    clients = Set()
963
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
964
 
                                 server_settings["port"]),
965
 
                                TCP_handler,
966
 
                                settings=server_settings,
967
 
                                clients=clients)
968
 
    pidfilename = "/var/run/mandos.pid"
969
 
    try:
970
 
        pidfile = open(pidfilename, "w")
971
 
    except IOError, error:
972
 
        logger.error("Could not open file %r", pidfilename)
973
 
    
974
 
    uid = 65534
975
 
    gid = 65534
976
 
    try:
977
 
        uid = pwd.getpwnam("mandos").pw_uid
978
 
    except KeyError:
979
 
        try:
980
 
            uid = pwd.getpwnam("nobody").pw_uid
981
 
        except KeyError:
982
 
            pass
983
 
    try:
984
 
        gid = pwd.getpwnam("mandos").pw_gid
985
 
    except KeyError:
986
 
        try:
987
 
            gid = pwd.getpwnam("nogroup").pw_gid
988
 
        except KeyError:
989
 
            pass
990
 
    try:
 
1802
    global mandos_dbus_service
 
1803
    mandos_dbus_service = None
 
1804
    
 
1805
    tcp_server = MandosServer((server_settings["address"],
 
1806
                               server_settings["port"]),
 
1807
                              ClientHandler,
 
1808
                              interface=(server_settings["interface"]
 
1809
                                         or None),
 
1810
                              use_ipv6=use_ipv6,
 
1811
                              gnutls_priority=
 
1812
                              server_settings["priority"],
 
1813
                              use_dbus=use_dbus)
 
1814
    if not debug:
 
1815
        pidfilename = "/var/run/mandos.pid"
 
1816
        try:
 
1817
            pidfile = open(pidfilename, "w")
 
1818
        except IOError:
 
1819
            logger.error("Could not open file %r", pidfilename)
 
1820
    
 
1821
    try:
 
1822
        uid = pwd.getpwnam("_mandos").pw_uid
 
1823
        gid = pwd.getpwnam("_mandos").pw_gid
 
1824
    except KeyError:
 
1825
        try:
 
1826
            uid = pwd.getpwnam("mandos").pw_uid
 
1827
            gid = pwd.getpwnam("mandos").pw_gid
 
1828
        except KeyError:
 
1829
            try:
 
1830
                uid = pwd.getpwnam("nobody").pw_uid
 
1831
                gid = pwd.getpwnam("nobody").pw_gid
 
1832
            except KeyError:
 
1833
                uid = 65534
 
1834
                gid = 65534
 
1835
    try:
 
1836
        os.setgid(gid)
991
1837
        os.setuid(uid)
992
 
        os.setgid(gid)
993
 
    except OSError, error:
 
1838
    except OSError as error:
994
1839
        if error[0] != errno.EPERM:
995
1840
            raise error
996
1841
    
997
 
    global service
998
 
    service = AvahiService(name = server_settings["servicename"],
999
 
                           servicetype = "_mandos._tcp", )
1000
 
    if server_settings["interface"]:
1001
 
        service.interface = (if_nametoindex
1002
 
                             (server_settings["interface"]))
1003
 
    
1004
 
    global main_loop
1005
 
    global bus
1006
 
    global server
1007
 
    # From the Avahi example code
1008
 
    DBusGMainLoop(set_as_default=True )
1009
 
    main_loop = gobject.MainLoop()
1010
 
    bus = dbus.SystemBus()
1011
 
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1012
 
                                           avahi.DBUS_PATH_SERVER),
1013
 
                            avahi.DBUS_INTERFACE_SERVER)
1014
 
    # End of Avahi example code
1015
 
    bus_name = dbus.service.BusName(u"org.mandos-system.Mandos", bus)
1016
 
    
1017
 
    def remove_from_clients(client):
1018
 
        clients.remove(client)
1019
 
        if not clients:
1020
 
            logger.critical(u"No clients left, exiting")
1021
 
            sys.exit()
1022
 
    
1023
 
    clients.update(Set(Client(name = section,
1024
 
                              stop_hook = remove_from_clients,
1025
 
                              config
1026
 
                              = dict(client_config.items(section)))
1027
 
                       for section in client_config.sections()))
1028
 
    if not clients:
1029
 
        logger.critical(u"No clients defined")
1030
 
        sys.exit(1)
1031
 
    
 
1842
    if not debug and not debuglevel:
 
1843
        syslogger.setLevel(logging.WARNING)
 
1844
        console.setLevel(logging.WARNING)
 
1845
    if debuglevel:
 
1846
        level = getattr(logging, debuglevel.upper())
 
1847
        syslogger.setLevel(level)
 
1848
        console.setLevel(level)
 
1849
 
1032
1850
    if debug:
 
1851
        # Enable all possible GnuTLS debugging
 
1852
        
 
1853
        # "Use a log level over 10 to enable all debugging options."
 
1854
        # - GnuTLS manual
 
1855
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
1856
        
 
1857
        @gnutls.library.types.gnutls_log_func
 
1858
        def debug_gnutls(level, string):
 
1859
            logger.debug("GnuTLS: %s", string[:-1])
 
1860
        
 
1861
        (gnutls.library.functions
 
1862
         .gnutls_global_set_log_function(debug_gnutls))
 
1863
        
1033
1864
        # Redirect stdin so all checkers get /dev/null
1034
1865
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1035
1866
        os.dup2(null, sys.stdin.fileno())
1038
1869
    else:
1039
1870
        # No console logging
1040
1871
        logger.removeHandler(console)
 
1872
    
 
1873
    # Need to fork before connecting to D-Bus
 
1874
    if not debug:
1041
1875
        # Close all input and output, do double fork, etc.
1042
1876
        daemon()
1043
1877
    
1044
 
    try:
1045
 
        pid = os.getpid()
1046
 
        pidfile.write(str(pid) + "\n")
1047
 
        pidfile.close()
1048
 
        del pidfile
1049
 
    except IOError:
1050
 
        logger.error(u"Could not write to file %r with PID %d",
1051
 
                     pidfilename, pid)
1052
 
    except NameError:
1053
 
        # "pidfile" was never created
1054
 
        pass
1055
 
    del pidfilename
 
1878
    global main_loop
 
1879
    # From the Avahi example code
 
1880
    DBusGMainLoop(set_as_default=True )
 
1881
    main_loop = gobject.MainLoop()
 
1882
    bus = dbus.SystemBus()
 
1883
    # End of Avahi example code
 
1884
    if use_dbus:
 
1885
        try:
 
1886
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
 
1887
                                            bus, do_not_queue=True)
 
1888
        except dbus.exceptions.NameExistsException as e:
 
1889
            logger.error(unicode(e) + ", disabling D-Bus")
 
1890
            use_dbus = False
 
1891
            server_settings["use_dbus"] = False
 
1892
            tcp_server.use_dbus = False
 
1893
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
1894
    service = AvahiService(name = server_settings["servicename"],
 
1895
                           servicetype = "_mandos._tcp",
 
1896
                           protocol = protocol, bus = bus)
 
1897
    if server_settings["interface"]:
 
1898
        service.interface = (if_nametoindex
 
1899
                             (str(server_settings["interface"])))
 
1900
    
 
1901
    global multiprocessing_manager
 
1902
    multiprocessing_manager = multiprocessing.Manager()
 
1903
    
 
1904
    client_class = Client
 
1905
    if use_dbus:
 
1906
        client_class = functools.partial(ClientDBus, bus = bus)
 
1907
    def client_config_items(config, section):
 
1908
        special_settings = {
 
1909
            "approved_by_default":
 
1910
                lambda: config.getboolean(section,
 
1911
                                          "approved_by_default"),
 
1912
            }
 
1913
        for name, value in config.items(section):
 
1914
            try:
 
1915
                yield (name, special_settings[name]())
 
1916
            except KeyError:
 
1917
                yield (name, value)
 
1918
    
 
1919
    tcp_server.clients.update(set(
 
1920
            client_class(name = section,
 
1921
                         config= dict(client_config_items(
 
1922
                        client_config, section)))
 
1923
            for section in client_config.sections()))
 
1924
    if not tcp_server.clients:
 
1925
        logger.warning("No clients defined")
 
1926
        
 
1927
    if not debug:
 
1928
        try:
 
1929
            with pidfile:
 
1930
                pid = os.getpid()
 
1931
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
1932
            del pidfile
 
1933
        except IOError:
 
1934
            logger.error("Could not write to file %r with PID %d",
 
1935
                         pidfilename, pid)
 
1936
        except NameError:
 
1937
            # "pidfile" was never created
 
1938
            pass
 
1939
        del pidfilename
 
1940
        
 
1941
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
1942
 
 
1943
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
1944
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
1945
    
 
1946
    if use_dbus:
 
1947
        class MandosDBusService(dbus.service.Object):
 
1948
            """A D-Bus proxy object"""
 
1949
            def __init__(self):
 
1950
                dbus.service.Object.__init__(self, bus, "/")
 
1951
            _interface = "se.bsnet.fukt.Mandos"
 
1952
            
 
1953
            @dbus.service.signal(_interface, signature="o")
 
1954
            def ClientAdded(self, objpath):
 
1955
                "D-Bus signal"
 
1956
                pass
 
1957
            
 
1958
            @dbus.service.signal(_interface, signature="ss")
 
1959
            def ClientNotFound(self, fingerprint, address):
 
1960
                "D-Bus signal"
 
1961
                pass
 
1962
            
 
1963
            @dbus.service.signal(_interface, signature="os")
 
1964
            def ClientRemoved(self, objpath, name):
 
1965
                "D-Bus signal"
 
1966
                pass
 
1967
            
 
1968
            @dbus.service.method(_interface, out_signature="ao")
 
1969
            def GetAllClients(self):
 
1970
                "D-Bus method"
 
1971
                return dbus.Array(c.dbus_object_path
 
1972
                                  for c in tcp_server.clients)
 
1973
            
 
1974
            @dbus.service.method(_interface,
 
1975
                                 out_signature="a{oa{sv}}")
 
1976
            def GetAllClientsWithProperties(self):
 
1977
                "D-Bus method"
 
1978
                return dbus.Dictionary(
 
1979
                    ((c.dbus_object_path, c.GetAll(""))
 
1980
                     for c in tcp_server.clients),
 
1981
                    signature="oa{sv}")
 
1982
            
 
1983
            @dbus.service.method(_interface, in_signature="o")
 
1984
            def RemoveClient(self, object_path):
 
1985
                "D-Bus method"
 
1986
                for c in tcp_server.clients:
 
1987
                    if c.dbus_object_path == object_path:
 
1988
                        tcp_server.clients.remove(c)
 
1989
                        c.remove_from_connection()
 
1990
                        # Don't signal anything except ClientRemoved
 
1991
                        c.disable(quiet=True)
 
1992
                        # Emit D-Bus signal
 
1993
                        self.ClientRemoved(object_path, c.name)
 
1994
                        return
 
1995
                raise KeyError(object_path)
 
1996
            
 
1997
            del _interface
 
1998
        
 
1999
        mandos_dbus_service = MandosDBusService()
1056
2000
    
1057
2001
    def cleanup():
1058
2002
        "Cleanup function; run on exit"
1059
 
        global group
1060
 
        # From the Avahi example code
1061
 
        if not group is None:
1062
 
            group.Free()
1063
 
            group = None
1064
 
        # End of Avahi example code
 
2003
        service.cleanup()
1065
2004
        
1066
 
        while clients:
1067
 
            client = clients.pop()
1068
 
            client.stop_hook = None
1069
 
            client.stop()
 
2005
        while tcp_server.clients:
 
2006
            client = tcp_server.clients.pop()
 
2007
            if use_dbus:
 
2008
                client.remove_from_connection()
 
2009
            client.disable_hook = None
 
2010
            # Don't signal anything except ClientRemoved
 
2011
            client.disable(quiet=True)
 
2012
            if use_dbus:
 
2013
                # Emit D-Bus signal
 
2014
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2015
                                                  client.name)
1070
2016
    
1071
2017
    atexit.register(cleanup)
1072
2018
    
1073
 
    if not debug:
1074
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1075
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1076
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1077
 
    
1078
 
    for client in clients:
1079
 
        client.start()
 
2019
    for client in tcp_server.clients:
 
2020
        if use_dbus:
 
2021
            # Emit D-Bus signal
 
2022
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
2023
        client.enable()
1080
2024
    
1081
2025
    tcp_server.enable()
1082
2026
    tcp_server.server_activate()
1083
2027
    
1084
2028
    # Find out what port we got
1085
2029
    service.port = tcp_server.socket.getsockname()[1]
1086
 
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
1087
 
                u" scope_id %d" % tcp_server.socket.getsockname())
 
2030
    if use_ipv6:
 
2031
        logger.info("Now listening on address %r, port %d,"
 
2032
                    " flowinfo %d, scope_id %d"
 
2033
                    % tcp_server.socket.getsockname())
 
2034
    else:                       # IPv4
 
2035
        logger.info("Now listening on address %r, port %d"
 
2036
                    % tcp_server.socket.getsockname())
1088
2037
    
1089
2038
    #service.interface = tcp_server.socket.getsockname()[3]
1090
2039
    
1091
2040
    try:
1092
2041
        # From the Avahi example code
1093
 
        server.connect_to_signal("StateChanged", server_state_changed)
1094
2042
        try:
1095
 
            server_state_changed(server.GetState())
1096
 
        except dbus.exceptions.DBusException, error:
1097
 
            logger.critical(u"DBusException: %s", error)
 
2043
            service.activate()
 
2044
        except dbus.exceptions.DBusException as error:
 
2045
            logger.critical("DBusException: %s", error)
 
2046
            cleanup()
1098
2047
            sys.exit(1)
1099
2048
        # End of Avahi example code
1100
2049
        
1103
2052
                             (tcp_server.handle_request
1104
2053
                              (*args[2:], **kwargs) or True))
1105
2054
        
1106
 
        logger.debug(u"Starting main loop")
 
2055
        logger.debug("Starting main loop")
1107
2056
        main_loop.run()
1108
 
    except AvahiError, error:
1109
 
        logger.critical(u"AvahiError: %s" + unicode(error))
 
2057
    except AvahiError as error:
 
2058
        logger.critical("AvahiError: %s", error)
 
2059
        cleanup()
1110
2060
        sys.exit(1)
1111
2061
    except KeyboardInterrupt:
1112
2062
        if debug:
1113
 
            print
 
2063
            print("", file=sys.stderr)
 
2064
        logger.debug("Server received KeyboardInterrupt")
 
2065
    logger.debug("Server exiting")
 
2066
    # Must run before the D-Bus bus name gets deregistered
 
2067
    cleanup()
1114
2068
 
1115
2069
if __name__ == '__main__':
1116
2070
    main()