/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: 2010-09-12 03:00:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

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