/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: 2008-12-10 01:26:02 UTC
  • mfrom: (237.1.2 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20081210012602-vhz3h75xkj24t340
First version of a somewhat complete D-Bus server interface.  Also
change user/group name to "_mandos".

* debian/mandos.postinst: Rename old "mandos" user and group to
                          "_mandos"; create "_mandos" user and group
                          if none exist.
* debian/mandos-client.postinst: - '' -

* initramfs-tools-hook: Try "_mandos" before "mandos" as user and
                        group name.

* mandos (_datetime_to_dbus_struct): New; was previously local.
  (Client.started): Renamed to "last_started".  All users changed.
  (Client.started): New; boolean.
  (Client.dbus_object_path): New.
  (Client.check_command): Renamed to "checker_command".  All users
                          changed.
  (Client.__init__): Set and use "self.dbus_object_path".  Set
                     "self.started".
  (Client.start): Update "self.started".  Emit "self.PropertyChanged"
                  signals for both "started" and "last_started".
  (Client.stop): Update "self.started".  Emit "self.PropertyChanged"
                 signal for "started".
  (Client.checker_callback): Take additional "command" argument.  All
                             callers changed. Emit
                             "self.PropertyChanged" signal.
  (Client.bump_timeout): Emit "self.PropertyChanged" signal for
                         "last_checked_ok".
  (Client.start_checker): Emit "self.PropertyChanged" signal for
                          "checker_running".
  (Client.stop_checker): Emit "self.PropertyChanged" signal for
                         "checker_running".
  (Client.still_valid): Bug fix: use "getattr(self, started, False)"
                        instead of "self.started" in case this client
                        object is so new that the "started" attribute
                        has not been created yet.
  (Client.IntervalChanged, Client.CheckerIsRunning, Client.GetChecker,
  Client.GetCreated, Client.GetFingerprint, Client.GetHost,
  Client.GetInterval, Client.GetName, Client.GetStarted,
  Client.GetTimeout, Client.StateChanged, Client.TimeoutChanged):
  Removed; all callers changed.
  (Client.CheckerCompleted): Add "condition" and "command" arguments.
                             All callers changed.
  (Client.GetAllProperties, Client.PropertyChanged): New.
  (Client.StillValid): Renamed to "IsStillValid".
  (Client.StartChecker): Changed to its own function to avoid the
                         return value from "Client.start_checker()".
  (Client.Stop): Changed to its own function to avoid the return value
                 from "Client.stop()".
  (main): Try "_mandos" before "mandos" as user and group name.
          Removed inner function "remove_from_clients".  New inner
          class "MandosServer".

Show diffs side-by-side

added added

removed removed

Lines of Context:
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
 
# methods "add", "remove", "server_state_changed",
10
 
# "entry_group_state_changed", "cleanup", and "activate" in the
11
 
# "AvahiService" class, and some lines in "main".
 
9
# 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".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008,2009 Teddy Hogeborn
15
 
# Copyright © 2008,2009 Björn Påhlsson
 
14
# Copyright © 2008 Teddy Hogeborn
 
15
# Copyright © 2008 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
33
33
 
34
34
from __future__ import division, with_statement, absolute_import
35
35
 
36
 
import SocketServer as socketserver
 
36
import SocketServer
37
37
import socket
38
 
import optparse
 
38
from optparse import OptionParser
39
39
import datetime
40
40
import errno
41
41
import gnutls.crypto
44
44
import gnutls.library.functions
45
45
import gnutls.library.constants
46
46
import gnutls.library.types
47
 
import ConfigParser as configparser
 
47
import ConfigParser
48
48
import sys
49
49
import re
50
50
import os
51
51
import signal
 
52
from sets import Set
52
53
import subprocess
53
54
import atexit
54
55
import stat
56
57
import logging.handlers
57
58
import pwd
58
59
from contextlib import closing
59
 
import struct
60
 
import fcntl
61
 
import functools
62
60
 
63
61
import dbus
64
62
import dbus.service
68
66
import ctypes
69
67
import ctypes.util
70
68
 
71
 
try:
72
 
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
73
 
except AttributeError:
74
 
    try:
75
 
        from IN import SO_BINDTODEVICE
76
 
    except ImportError:
77
 
        SO_BINDTODEVICE = None
78
 
 
79
 
 
80
 
version = "1.0.13"
81
 
 
82
 
logger = logging.Logger(u'mandos')
 
69
version = "1.0.2"
 
70
 
 
71
logger = logging.Logger('mandos')
83
72
syslogger = (logging.handlers.SysLogHandler
84
73
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
85
74
              address = "/dev/log"))
86
75
syslogger.setFormatter(logging.Formatter
87
 
                       (u'Mandos [%(process)d]: %(levelname)s:'
88
 
                        u' %(message)s'))
 
76
                       ('Mandos: %(levelname)s: %(message)s'))
89
77
logger.addHandler(syslogger)
90
78
 
91
79
console = logging.StreamHandler()
92
 
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
93
 
                                       u' %(levelname)s:'
94
 
                                       u' %(message)s'))
 
80
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
 
81
                                       ' %(message)s'))
95
82
logger.addHandler(console)
96
83
 
97
84
class AvahiError(Exception):
98
 
    def __init__(self, value, *args, **kwargs):
 
85
    def __init__(self, value):
99
86
        self.value = value
100
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
101
 
    def __unicode__(self):
102
 
        return unicode(repr(self.value))
 
87
        super(AvahiError, self).__init__()
 
88
    def __str__(self):
 
89
        return repr(self.value)
103
90
 
104
91
class AvahiServiceError(AvahiError):
105
92
    pass
110
97
 
111
98
class AvahiService(object):
112
99
    """An Avahi (Zeroconf) service.
113
 
    
114
100
    Attributes:
115
101
    interface: integer; avahi.IF_UNSPEC or an interface index.
116
102
               Used to optionally bind to the specified interface.
117
 
    name: string; Example: u'Mandos'
118
 
    type: string; Example: u'_mandos._tcp'.
 
103
    name: string; Example: 'Mandos'
 
104
    type: string; Example: '_mandos._tcp'.
119
105
                  See <http://www.dns-sd.org/ServiceTypes.html>
120
106
    port: integer; what port to announce
121
107
    TXT: list of strings; TXT record for the service
124
110
    max_renames: integer; maximum number of renames
125
111
    rename_count: integer; counter so we only rename after collisions
126
112
                  a sensible number of times
127
 
    group: D-Bus Entry Group
128
 
    server: D-Bus Server
129
 
    bus: dbus.SystemBus()
130
113
    """
131
114
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
132
115
                 servicetype = None, port = None, TXT = None,
133
 
                 domain = u"", host = u"", max_renames = 32768,
134
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
116
                 domain = "", host = "", max_renames = 32768):
135
117
        self.interface = interface
136
118
        self.name = name
137
119
        self.type = servicetype
141
123
        self.host = host
142
124
        self.rename_count = 0
143
125
        self.max_renames = max_renames
144
 
        self.protocol = protocol
145
 
        self.group = None       # our entry group
146
 
        self.server = None
147
 
        self.bus = bus
148
126
    def rename(self):
149
127
        """Derived from the Avahi example code"""
150
128
        if self.rename_count >= self.max_renames:
151
129
            logger.critical(u"No suitable Zeroconf service name found"
152
130
                            u" after %i retries, exiting.",
153
131
                            self.rename_count)
154
 
            raise AvahiServiceError(u"Too many renames")
155
 
        self.name = self.server.GetAlternativeServiceName(self.name)
 
132
            raise AvahiServiceError("Too many renames")
 
133
        self.name = server.GetAlternativeServiceName(self.name)
156
134
        logger.info(u"Changing Zeroconf service name to %r ...",
157
 
                    unicode(self.name))
 
135
                    str(self.name))
158
136
        syslogger.setFormatter(logging.Formatter
159
 
                               (u'Mandos (%s) [%%(process)d]:'
160
 
                                u' %%(levelname)s: %%(message)s'
161
 
                                % self.name))
 
137
                               ('Mandos (%s): %%(levelname)s:'
 
138
                                ' %%(message)s' % self.name))
162
139
        self.remove()
163
140
        self.add()
164
141
        self.rename_count += 1
165
142
    def remove(self):
166
143
        """Derived from the Avahi example code"""
167
 
        if self.group is not None:
168
 
            self.group.Reset()
 
144
        if group is not None:
 
145
            group.Reset()
169
146
    def add(self):
170
147
        """Derived from the Avahi example code"""
171
 
        if self.group is None:
172
 
            self.group = dbus.Interface(
173
 
                self.bus.get_object(avahi.DBUS_NAME,
174
 
                                    self.server.EntryGroupNew()),
175
 
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
176
 
            self.group.connect_to_signal('StateChanged',
177
 
                                         self.entry_group_state_changed)
 
148
        global group
 
149
        if group is None:
 
150
            group = dbus.Interface(bus.get_object
 
151
                                   (avahi.DBUS_NAME,
 
152
                                    server.EntryGroupNew()),
 
153
                                   avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
154
            group.connect_to_signal('StateChanged',
 
155
                                    entry_group_state_changed)
178
156
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
179
 
                     self.name, self.type)
180
 
        self.group.AddService(
181
 
            self.interface,
182
 
            self.protocol,
183
 
            dbus.UInt32(0),     # flags
184
 
            self.name, self.type,
185
 
            self.domain, self.host,
186
 
            dbus.UInt16(self.port),
187
 
            avahi.string_array_to_txt_array(self.TXT))
188
 
        self.group.Commit()
189
 
    def entry_group_state_changed(self, state, error):
190
 
        """Derived from the Avahi example code"""
191
 
        logger.debug(u"Avahi state change: %i", state)
192
 
        
193
 
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
194
 
            logger.debug(u"Zeroconf service established.")
195
 
        elif state == avahi.ENTRY_GROUP_COLLISION:
196
 
            logger.warning(u"Zeroconf service name collision.")
197
 
            self.rename()
198
 
        elif state == avahi.ENTRY_GROUP_FAILURE:
199
 
            logger.critical(u"Avahi: Error in group state changed %s",
200
 
                            unicode(error))
201
 
            raise AvahiGroupError(u"State changed: %s"
202
 
                                  % unicode(error))
203
 
    def cleanup(self):
204
 
        """Derived from the Avahi example code"""
205
 
        if self.group is not None:
206
 
            self.group.Free()
207
 
            self.group = None
208
 
    def server_state_changed(self, state):
209
 
        """Derived from the Avahi example code"""
210
 
        if state == avahi.SERVER_COLLISION:
211
 
            logger.error(u"Zeroconf server name collision")
212
 
            self.remove()
213
 
        elif state == avahi.SERVER_RUNNING:
214
 
            self.add()
215
 
    def activate(self):
216
 
        """Derived from the Avahi example code"""
217
 
        if self.server is None:
218
 
            self.server = dbus.Interface(
219
 
                self.bus.get_object(avahi.DBUS_NAME,
220
 
                                    avahi.DBUS_PATH_SERVER),
221
 
                avahi.DBUS_INTERFACE_SERVER)
222
 
        self.server.connect_to_signal(u"StateChanged",
223
 
                                 self.server_state_changed)
224
 
        self.server_state_changed(self.server.GetState())
225
 
 
226
 
 
227
 
class Client(object):
 
157
                     service.name, service.type)
 
158
        group.AddService(
 
159
                self.interface,         # interface
 
160
                avahi.PROTO_INET6,      # protocol
 
161
                dbus.UInt32(0),         # flags
 
162
                self.name, self.type,
 
163
                self.domain, self.host,
 
164
                dbus.UInt16(self.port),
 
165
                avahi.string_array_to_txt_array(self.TXT))
 
166
        group.Commit()
 
167
 
 
168
# From the Avahi example code:
 
169
group = None                            # our entry group
 
170
# End of Avahi example code
 
171
 
 
172
 
 
173
def _datetime_to_dbus_struct(dt, variant_level=0):
 
174
    """Convert a UTC datetime.datetime() to a D-Bus struct.
 
175
    The format is special to this application, since we could not find
 
176
    any other standard way."""
 
177
    return dbus.Struct((dbus.Int16(dt.year),
 
178
                        dbus.Byte(dt.month),
 
179
                        dbus.Byte(dt.day),
 
180
                        dbus.Byte(dt.hour),
 
181
                        dbus.Byte(dt.minute),
 
182
                        dbus.Byte(dt.second),
 
183
                        dbus.UInt32(dt.microsecond)),
 
184
                       signature="nyyyyyu",
 
185
                       variant_level=variant_level)
 
186
 
 
187
 
 
188
class Client(dbus.service.Object):
228
189
    """A representation of a client host served by this server.
229
 
    
230
190
    Attributes:
231
 
    name:       string; from the config file, used in log messages and
232
 
                        D-Bus identifiers
 
191
    name:       string; from the config file, used in log messages
233
192
    fingerprint: string (40 or 32 hexadecimal digits); used to
234
193
                 uniquely identify the client
235
194
    secret:     bytestring; sent verbatim (over TLS) to client
236
195
    host:       string; available for use by the checker command
237
196
    created:    datetime.datetime(); (UTC) object creation
238
 
    last_enabled: datetime.datetime(); (UTC)
239
 
    enabled:    bool()
 
197
    last_started: datetime.datetime(); (UTC)
 
198
    started:    bool()
240
199
    last_checked_ok: datetime.datetime(); (UTC) or None
241
200
    timeout:    datetime.timedelta(); How long from last_checked_ok
242
201
                                      until this client is invalid
243
202
    interval:   datetime.timedelta(); How often to start a new checker
244
 
    disable_hook:  If set, called by disable() as disable_hook(self)
 
203
    stop_hook:  If set, called by stop() as stop_hook(self)
245
204
    checker:    subprocess.Popen(); a running checker process used
246
205
                                    to see if the client lives.
247
206
                                    'None' if no process is running.
248
207
    checker_initiator_tag: a gobject event source tag, or None
249
 
    disable_initiator_tag:    - '' -
 
208
    stop_initiator_tag:    - '' -
250
209
    checker_callback_tag:  - '' -
251
210
    checker_command: string; External command which is run to check if
252
211
                     client lives.  %() expansions are done at
253
212
                     runtime with vars(self) as dict, so that for
254
213
                     instance %(name)s can be used in the command.
255
 
    current_checker_command: string; current running checker_command
 
214
    dbus_object_path: dbus.ObjectPath
 
215
    Private attibutes:
 
216
    _timeout: Real variable for 'timeout'
 
217
    _interval: Real variable for 'interval'
 
218
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
219
    _interval_milliseconds: - '' -
256
220
    """
257
 
    
258
 
    @staticmethod
259
 
    def _datetime_to_milliseconds(dt):
260
 
        "Convert a datetime.datetime() to milliseconds"
261
 
        return ((dt.days * 24 * 60 * 60 * 1000)
262
 
                + (dt.seconds * 1000)
263
 
                + (dt.microseconds // 1000))
264
 
    
265
 
    def timeout_milliseconds(self):
266
 
        "Return the 'timeout' attribute in milliseconds"
267
 
        return self._datetime_to_milliseconds(self.timeout)
268
 
    
269
 
    def interval_milliseconds(self):
270
 
        "Return the 'interval' attribute in milliseconds"
271
 
        return self._datetime_to_milliseconds(self.interval)
272
 
    
273
 
    def __init__(self, name = None, disable_hook=None, config=None):
 
221
    def _set_timeout(self, timeout):
 
222
        "Setter function for the 'timeout' attribute"
 
223
        self._timeout = timeout
 
224
        self._timeout_milliseconds = ((self.timeout.days
 
225
                                       * 24 * 60 * 60 * 1000)
 
226
                                      + (self.timeout.seconds * 1000)
 
227
                                      + (self.timeout.microseconds
 
228
                                         // 1000))
 
229
        # Emit D-Bus signal
 
230
        self.PropertyChanged(dbus.String(u"timeout"),
 
231
                             (dbus.UInt64(self._timeout_milliseconds,
 
232
                                          variant_level=1)))
 
233
    timeout = property(lambda self: self._timeout, _set_timeout)
 
234
    del _set_timeout
 
235
    
 
236
    def _set_interval(self, interval):
 
237
        "Setter function for the 'interval' attribute"
 
238
        self._interval = interval
 
239
        self._interval_milliseconds = ((self.interval.days
 
240
                                        * 24 * 60 * 60 * 1000)
 
241
                                       + (self.interval.seconds
 
242
                                          * 1000)
 
243
                                       + (self.interval.microseconds
 
244
                                          // 1000))
 
245
        # Emit D-Bus signal
 
246
        self.PropertyChanged(dbus.String(u"interval"),
 
247
                             (dbus.UInt64(self._interval_milliseconds,
 
248
                                          variant_level=1)))
 
249
    interval = property(lambda self: self._interval, _set_interval)
 
250
    del _set_interval
 
251
    
 
252
    def __init__(self, name = None, stop_hook=None, config=None):
274
253
        """Note: the 'checker' key in 'config' sets the
275
254
        'checker_command' attribute and *not* the 'checker'
276
255
        attribute."""
277
 
        self.name = name
 
256
        self.dbus_object_path = (dbus.ObjectPath
 
257
                                 ("/Mandos/clients/"
 
258
                                  + name.replace(".", "_")))
 
259
        dbus.service.Object.__init__(self, bus,
 
260
                                     self.dbus_object_path)
278
261
        if config is None:
279
262
            config = {}
 
263
        self.name = name
280
264
        logger.debug(u"Creating client %r", self.name)
281
265
        # Uppercase and remove spaces from fingerprint for later
282
266
        # comparison purposes with return value from the fingerprint()
283
267
        # function
284
 
        self.fingerprint = (config[u"fingerprint"].upper()
 
268
        self.fingerprint = (config["fingerprint"].upper()
285
269
                            .replace(u" ", u""))
286
270
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
287
 
        if u"secret" in config:
288
 
            self.secret = config[u"secret"].decode(u"base64")
289
 
        elif u"secfile" in config:
 
271
        if "secret" in config:
 
272
            self.secret = config["secret"].decode(u"base64")
 
273
        elif "secfile" in config:
290
274
            with closing(open(os.path.expanduser
291
275
                              (os.path.expandvars
292
 
                               (config[u"secfile"])))) as secfile:
 
276
                               (config["secfile"])))) as secfile:
293
277
                self.secret = secfile.read()
294
278
        else:
295
279
            raise TypeError(u"No secret or secfile for client %s"
296
280
                            % self.name)
297
 
        self.host = config.get(u"host", u"")
 
281
        self.host = config.get("host", "")
298
282
        self.created = datetime.datetime.utcnow()
299
 
        self.enabled = False
300
 
        self.last_enabled = None
 
283
        self.started = False
 
284
        self.last_started = None
301
285
        self.last_checked_ok = None
302
 
        self.timeout = string_to_delta(config[u"timeout"])
303
 
        self.interval = string_to_delta(config[u"interval"])
304
 
        self.disable_hook = disable_hook
 
286
        self.timeout = string_to_delta(config["timeout"])
 
287
        self.interval = string_to_delta(config["interval"])
 
288
        self.stop_hook = stop_hook
305
289
        self.checker = None
306
290
        self.checker_initiator_tag = None
307
 
        self.disable_initiator_tag = None
 
291
        self.stop_initiator_tag = None
308
292
        self.checker_callback_tag = None
309
 
        self.checker_command = config[u"checker"]
310
 
        self.current_checker_command = None
311
 
        self.last_connect = None
 
293
        self.checker_command = config["checker"]
312
294
    
313
 
    def enable(self):
 
295
    def start(self):
314
296
        """Start this client's checker and timeout hooks"""
315
 
        if getattr(self, u"enabled", False):
316
 
            # Already enabled
317
 
            return
318
 
        self.last_enabled = datetime.datetime.utcnow()
 
297
        self.last_started = datetime.datetime.utcnow()
319
298
        # Schedule a new checker to be started an 'interval' from now,
320
299
        # and every interval from then on.
321
300
        self.checker_initiator_tag = (gobject.timeout_add
322
 
                                      (self.interval_milliseconds(),
 
301
                                      (self._interval_milliseconds,
323
302
                                       self.start_checker))
324
303
        # Also start a new checker *right now*.
325
304
        self.start_checker()
326
 
        # Schedule a disable() when 'timeout' has passed
327
 
        self.disable_initiator_tag = (gobject.timeout_add
328
 
                                   (self.timeout_milliseconds(),
329
 
                                    self.disable))
330
 
        self.enabled = True
 
305
        # Schedule a stop() when 'timeout' has passed
 
306
        self.stop_initiator_tag = (gobject.timeout_add
 
307
                                   (self._timeout_milliseconds,
 
308
                                    self.stop))
 
309
        self.started = True
 
310
        # Emit D-Bus signal
 
311
        self.PropertyChanged(dbus.String(u"started"),
 
312
                             dbus.Boolean(True, variant_level=1))
 
313
        self.PropertyChanged(dbus.String(u"last_started"),
 
314
                             (_datetime_to_dbus_struct
 
315
                              (self.last_started, variant_level=1)))
331
316
    
332
 
    def disable(self):
333
 
        """Disable this client."""
334
 
        if not getattr(self, "enabled", False):
 
317
    def stop(self):
 
318
        """Stop this client."""
 
319
        if not getattr(self, "started", False):
335
320
            return False
336
 
        logger.info(u"Disabling client %s", self.name)
337
 
        if getattr(self, u"disable_initiator_tag", False):
338
 
            gobject.source_remove(self.disable_initiator_tag)
339
 
            self.disable_initiator_tag = None
340
 
        if getattr(self, u"checker_initiator_tag", False):
 
321
        logger.info(u"Stopping client %s", self.name)
 
322
        if getattr(self, "stop_initiator_tag", False):
 
323
            gobject.source_remove(self.stop_initiator_tag)
 
324
            self.stop_initiator_tag = None
 
325
        if getattr(self, "checker_initiator_tag", False):
341
326
            gobject.source_remove(self.checker_initiator_tag)
342
327
            self.checker_initiator_tag = None
343
328
        self.stop_checker()
344
 
        if self.disable_hook:
345
 
            self.disable_hook(self)
346
 
        self.enabled = False
 
329
        if self.stop_hook:
 
330
            self.stop_hook(self)
 
331
        self.started = False
 
332
        # Emit D-Bus signal
 
333
        self.PropertyChanged(dbus.String(u"started"),
 
334
                             dbus.Boolean(False, variant_level=1))
347
335
        # Do not run this again if called by a gobject.timeout_add
348
336
        return False
349
337
    
350
338
    def __del__(self):
351
 
        self.disable_hook = None
352
 
        self.disable()
 
339
        self.stop_hook = None
 
340
        self.stop()
353
341
    
354
342
    def checker_callback(self, pid, condition, command):
355
343
        """The checker has completed, so take appropriate actions."""
356
344
        self.checker_callback_tag = None
357
345
        self.checker = None
358
 
        if os.WIFEXITED(condition):
359
 
            exitstatus = os.WEXITSTATUS(condition)
360
 
            if exitstatus == 0:
361
 
                logger.info(u"Checker for %(name)s succeeded",
362
 
                            vars(self))
363
 
                self.checked_ok()
364
 
            else:
365
 
                logger.info(u"Checker for %(name)s failed",
366
 
                            vars(self))
367
 
        else:
 
346
        # Emit D-Bus signal
 
347
        self.PropertyChanged(dbus.String(u"checker_running"),
 
348
                             dbus.Boolean(False, variant_level=1))
 
349
        if (os.WIFEXITED(condition)
 
350
            and (os.WEXITSTATUS(condition) == 0)):
 
351
            logger.info(u"Checker for %(name)s succeeded",
 
352
                        vars(self))
 
353
            # Emit D-Bus signal
 
354
            self.CheckerCompleted(dbus.Boolean(True),
 
355
                                  dbus.UInt16(condition),
 
356
                                  dbus.String(command))
 
357
            self.bump_timeout()
 
358
        elif not os.WIFEXITED(condition):
368
359
            logger.warning(u"Checker for %(name)s crashed?",
369
360
                           vars(self))
 
361
            # Emit D-Bus signal
 
362
            self.CheckerCompleted(dbus.Boolean(False),
 
363
                                  dbus.UInt16(condition),
 
364
                                  dbus.String(command))
 
365
        else:
 
366
            logger.info(u"Checker for %(name)s failed",
 
367
                        vars(self))
 
368
            # Emit D-Bus signal
 
369
            self.CheckerCompleted(dbus.Boolean(False),
 
370
                                  dbus.UInt16(condition),
 
371
                                  dbus.String(command))
370
372
    
371
 
    def checked_ok(self):
 
373
    def bump_timeout(self):
372
374
        """Bump up the timeout for this client.
373
 
        
374
375
        This should only be called when the client has been seen,
375
376
        alive and well.
376
377
        """
377
378
        self.last_checked_ok = datetime.datetime.utcnow()
378
 
        gobject.source_remove(self.disable_initiator_tag)
379
 
        self.disable_initiator_tag = (gobject.timeout_add
380
 
                                      (self.timeout_milliseconds(),
381
 
                                       self.disable))
 
379
        gobject.source_remove(self.stop_initiator_tag)
 
380
        self.stop_initiator_tag = (gobject.timeout_add
 
381
                                   (self._timeout_milliseconds,
 
382
                                    self.stop))
 
383
        self.PropertyChanged(dbus.String(u"last_checked_ok"),
 
384
                             (_datetime_to_dbus_struct
 
385
                              (self.last_checked_ok,
 
386
                               variant_level=1)))
382
387
    
383
388
    def start_checker(self):
384
389
        """Start a new checker subprocess if one is not running.
385
 
        
386
390
        If a checker already exists, leave it running and do
387
391
        nothing."""
388
392
        # The reason for not killing a running checker is that if we
393
397
        # checkers alone, the checker would have to take more time
394
398
        # than 'timeout' for the client to be declared invalid, which
395
399
        # is as it should be.
396
 
        
397
 
        # If a checker exists, make sure it is not a zombie
398
 
        if self.checker is not None:
399
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
400
 
            if pid:
401
 
                logger.warning(u"Checker was a zombie")
402
 
                gobject.source_remove(self.checker_callback_tag)
403
 
                self.checker_callback(pid, status,
404
 
                                      self.current_checker_command)
405
 
        # Start a new checker if needed
406
400
        if self.checker is None:
407
401
            try:
408
402
                # In case checker_command has exactly one % operator
409
403
                command = self.checker_command % self.host
410
404
            except TypeError:
411
405
                # Escape attributes for the shell
412
 
                escaped_attrs = dict((key,
413
 
                                      re.escape(unicode(str(val),
414
 
                                                        errors=
415
 
                                                        u'replace')))
 
406
                escaped_attrs = dict((key, re.escape(str(val)))
416
407
                                     for key, val in
417
408
                                     vars(self).iteritems())
418
409
                try:
421
412
                    logger.error(u'Could not format string "%s":'
422
413
                                 u' %s', self.checker_command, error)
423
414
                    return True # Try again later
424
 
            self.current_checker_command = command
425
415
            try:
426
416
                logger.info(u"Starting checker %r for %s",
427
417
                            command, self.name)
431
421
                # always replaced by /dev/null.)
432
422
                self.checker = subprocess.Popen(command,
433
423
                                                close_fds=True,
434
 
                                                shell=True, cwd=u"/")
 
424
                                                shell=True, cwd="/")
 
425
                # Emit D-Bus signal
 
426
                self.CheckerStarted(command)
 
427
                self.PropertyChanged(dbus.String("checker_running"),
 
428
                                     dbus.Boolean(True, variant_level=1))
435
429
                self.checker_callback_tag = (gobject.child_watch_add
436
430
                                             (self.checker.pid,
437
431
                                              self.checker_callback,
438
432
                                              data=command))
439
 
                # The checker may have completed before the gobject
440
 
                # watch was added.  Check for this.
441
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
442
 
                if pid:
443
 
                    gobject.source_remove(self.checker_callback_tag)
444
 
                    self.checker_callback(pid, status, command)
445
433
            except OSError, error:
446
434
                logger.error(u"Failed to start subprocess: %s",
447
435
                             error)
453
441
        if self.checker_callback_tag:
454
442
            gobject.source_remove(self.checker_callback_tag)
455
443
            self.checker_callback_tag = None
456
 
        if getattr(self, u"checker", None) is None:
 
444
        if getattr(self, "checker", None) is None:
457
445
            return
458
446
        logger.debug(u"Stopping checker for %(name)s", vars(self))
459
447
        try:
465
453
            if error.errno != errno.ESRCH: # No such process
466
454
                raise
467
455
        self.checker = None
 
456
        self.PropertyChanged(dbus.String(u"checker_running"),
 
457
                             dbus.Boolean(False, variant_level=1))
468
458
    
469
459
    def still_valid(self):
470
460
        """Has the timeout not yet passed for this client?"""
471
 
        if not getattr(self, u"enabled", False):
 
461
        if not getattr(self, "started", False):
472
462
            return False
473
463
        now = datetime.datetime.utcnow()
474
464
        if self.last_checked_ok is None:
475
465
            return now < (self.created + self.timeout)
476
466
        else:
477
467
            return now < (self.last_checked_ok + self.timeout)
478
 
 
479
 
 
480
 
class ClientDBus(Client, dbus.service.Object):
481
 
    """A Client class using D-Bus
482
 
    
483
 
    Attributes:
484
 
    dbus_object_path: dbus.ObjectPath
485
 
    bus: dbus.SystemBus()
486
 
    """
487
 
    # dbus.service.Object doesn't use super(), so we can't either.
488
 
    
489
 
    def __init__(self, bus = None, *args, **kwargs):
490
 
        self.bus = bus
491
 
        Client.__init__(self, *args, **kwargs)
492
 
        # Only now, when this client is initialized, can it show up on
493
 
        # the D-Bus
494
 
        self.dbus_object_path = (dbus.ObjectPath
495
 
                                 (u"/clients/"
496
 
                                  + self.name.replace(u".", u"_")))
497
 
        dbus.service.Object.__init__(self, self.bus,
498
 
                                     self.dbus_object_path)
499
 
    
500
 
    @staticmethod
501
 
    def _datetime_to_dbus(dt, variant_level=0):
502
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
503
 
        return dbus.String(dt.isoformat(),
504
 
                           variant_level=variant_level)
505
 
    
506
 
    def enable(self):
507
 
        oldstate = getattr(self, u"enabled", False)
508
 
        r = Client.enable(self)
509
 
        if oldstate != self.enabled:
510
 
            # Emit D-Bus signals
511
 
            self.PropertyChanged(dbus.String(u"enabled"),
512
 
                                 dbus.Boolean(True, variant_level=1))
513
 
            self.PropertyChanged(
514
 
                dbus.String(u"last_enabled"),
515
 
                self._datetime_to_dbus(self.last_enabled,
516
 
                                       variant_level=1))
517
 
        return r
518
 
    
519
 
    def disable(self, signal = True):
520
 
        oldstate = getattr(self, u"enabled", False)
521
 
        r = Client.disable(self)
522
 
        if signal and oldstate != self.enabled:
523
 
            # Emit D-Bus signal
524
 
            self.PropertyChanged(dbus.String(u"enabled"),
525
 
                                 dbus.Boolean(False, variant_level=1))
526
 
        return r
527
 
    
528
 
    def __del__(self, *args, **kwargs):
529
 
        try:
530
 
            self.remove_from_connection()
531
 
        except LookupError:
532
 
            pass
533
 
        if hasattr(dbus.service.Object, u"__del__"):
534
 
            dbus.service.Object.__del__(self, *args, **kwargs)
535
 
        Client.__del__(self, *args, **kwargs)
536
 
    
537
 
    def checker_callback(self, pid, condition, command,
538
 
                         *args, **kwargs):
539
 
        self.checker_callback_tag = None
540
 
        self.checker = None
541
 
        # Emit D-Bus signal
542
 
        self.PropertyChanged(dbus.String(u"checker_running"),
543
 
                             dbus.Boolean(False, variant_level=1))
544
 
        if os.WIFEXITED(condition):
545
 
            exitstatus = os.WEXITSTATUS(condition)
546
 
            # Emit D-Bus signal
547
 
            self.CheckerCompleted(dbus.Int16(exitstatus),
548
 
                                  dbus.Int64(condition),
549
 
                                  dbus.String(command))
550
 
        else:
551
 
            # Emit D-Bus signal
552
 
            self.CheckerCompleted(dbus.Int16(-1),
553
 
                                  dbus.Int64(condition),
554
 
                                  dbus.String(command))
555
 
        
556
 
        return Client.checker_callback(self, pid, condition, command,
557
 
                                       *args, **kwargs)
558
 
    
559
 
    def checked_ok(self, *args, **kwargs):
560
 
        r = Client.checked_ok(self, *args, **kwargs)
561
 
        # Emit D-Bus signal
562
 
        self.PropertyChanged(
563
 
            dbus.String(u"last_checked_ok"),
564
 
            (self._datetime_to_dbus(self.last_checked_ok,
565
 
                                    variant_level=1)))
566
 
        return r
567
 
    
568
 
    def start_checker(self, *args, **kwargs):
569
 
        old_checker = self.checker
570
 
        if self.checker is not None:
571
 
            old_checker_pid = self.checker.pid
572
 
        else:
573
 
            old_checker_pid = None
574
 
        r = Client.start_checker(self, *args, **kwargs)
575
 
        # Only if new checker process was started
576
 
        if (self.checker is not None
577
 
            and old_checker_pid != self.checker.pid):
578
 
            # Emit D-Bus signal
579
 
            self.CheckerStarted(self.current_checker_command)
580
 
            self.PropertyChanged(
581
 
                dbus.String(u"checker_running"),
582
 
                dbus.Boolean(True, variant_level=1))
583
 
        return r
584
 
    
585
 
    def stop_checker(self, *args, **kwargs):
586
 
        old_checker = getattr(self, u"checker", None)
587
 
        r = Client.stop_checker(self, *args, **kwargs)
588
 
        if (old_checker is not None
589
 
            and getattr(self, u"checker", None) is None):
590
 
            self.PropertyChanged(dbus.String(u"checker_running"),
591
 
                                 dbus.Boolean(False, variant_level=1))
592
 
        return r
593
468
    
594
469
    ## D-Bus methods & signals
595
 
    _interface = u"se.bsnet.fukt.Mandos.Client"
 
470
    _interface = u"org.mandos_system.Mandos.Client"
596
471
    
597
 
    # CheckedOK - method
598
 
    @dbus.service.method(_interface)
599
 
    def CheckedOK(self):
600
 
        return self.checked_ok()
 
472
    # BumpTimeout - method
 
473
    BumpTimeout = dbus.service.method(_interface)(bump_timeout)
 
474
    BumpTimeout.__name__ = "BumpTimeout"
601
475
    
602
476
    # CheckerCompleted - signal
603
 
    @dbus.service.signal(_interface, signature=u"nxs")
604
 
    def CheckerCompleted(self, exitcode, waitstatus, command):
 
477
    @dbus.service.signal(_interface, signature="bqs")
 
478
    def CheckerCompleted(self, success, condition, command):
605
479
        "D-Bus signal"
606
480
        pass
607
481
    
608
482
    # CheckerStarted - signal
609
 
    @dbus.service.signal(_interface, signature=u"s")
 
483
    @dbus.service.signal(_interface, signature="s")
610
484
    def CheckerStarted(self, command):
611
485
        "D-Bus signal"
612
486
        pass
613
487
    
614
488
    # GetAllProperties - method
615
 
    @dbus.service.method(_interface, out_signature=u"a{sv}")
 
489
    @dbus.service.method(_interface, out_signature="a{sv}")
616
490
    def GetAllProperties(self):
617
491
        "D-Bus method"
618
492
        return dbus.Dictionary({
619
 
                dbus.String(u"name"):
 
493
                dbus.String("name"):
620
494
                    dbus.String(self.name, variant_level=1),
621
 
                dbus.String(u"fingerprint"):
 
495
                dbus.String("fingerprint"):
622
496
                    dbus.String(self.fingerprint, variant_level=1),
623
 
                dbus.String(u"host"):
 
497
                dbus.String("host"):
624
498
                    dbus.String(self.host, variant_level=1),
625
 
                dbus.String(u"created"):
626
 
                    self._datetime_to_dbus(self.created,
627
 
                                           variant_level=1),
628
 
                dbus.String(u"last_enabled"):
629
 
                    (self._datetime_to_dbus(self.last_enabled,
630
 
                                            variant_level=1)
631
 
                     if self.last_enabled is not None
 
499
                dbus.String("created"):
 
500
                    _datetime_to_dbus_struct(self.created,
 
501
                                             variant_level=1),
 
502
                dbus.String("last_started"):
 
503
                    (_datetime_to_dbus_struct(self.last_started,
 
504
                                              variant_level=1)
 
505
                     if self.last_started is not None
632
506
                     else dbus.Boolean(False, variant_level=1)),
633
 
                dbus.String(u"enabled"):
634
 
                    dbus.Boolean(self.enabled, variant_level=1),
635
 
                dbus.String(u"last_checked_ok"):
636
 
                    (self._datetime_to_dbus(self.last_checked_ok,
637
 
                                            variant_level=1)
 
507
                dbus.String("started"):
 
508
                    dbus.Boolean(self.started, variant_level=1),
 
509
                dbus.String("last_checked_ok"):
 
510
                    (_datetime_to_dbus_struct(self.last_checked_ok,
 
511
                                              variant_level=1)
638
512
                     if self.last_checked_ok is not None
639
513
                     else dbus.Boolean (False, variant_level=1)),
640
 
                dbus.String(u"timeout"):
641
 
                    dbus.UInt64(self.timeout_milliseconds(),
642
 
                                variant_level=1),
643
 
                dbus.String(u"interval"):
644
 
                    dbus.UInt64(self.interval_milliseconds(),
645
 
                                variant_level=1),
646
 
                dbus.String(u"checker"):
 
514
                dbus.String("timeout"):
 
515
                    dbus.UInt64(self._timeout_milliseconds,
 
516
                                variant_level=1),
 
517
                dbus.String("interval"):
 
518
                    dbus.UInt64(self._interval_milliseconds,
 
519
                                variant_level=1),
 
520
                dbus.String("checker"):
647
521
                    dbus.String(self.checker_command,
648
522
                                variant_level=1),
649
 
                dbus.String(u"checker_running"):
 
523
                dbus.String("checker_running"):
650
524
                    dbus.Boolean(self.checker is not None,
651
525
                                 variant_level=1),
652
 
                dbus.String(u"object_path"):
653
 
                    dbus.ObjectPath(self.dbus_object_path,
654
 
                                    variant_level=1)
655
 
                }, signature=u"sv")
 
526
                }, signature="sv")
656
527
    
657
528
    # IsStillValid - method
658
 
    @dbus.service.method(_interface, out_signature=u"b")
659
 
    def IsStillValid(self):
660
 
        return self.still_valid()
 
529
    IsStillValid = (dbus.service.method(_interface, out_signature="b")
 
530
                    (still_valid))
 
531
    IsStillValid.__name__ = "IsStillValid"
661
532
    
662
533
    # PropertyChanged - signal
663
 
    @dbus.service.signal(_interface, signature=u"sv")
 
534
    @dbus.service.signal(_interface, signature="sv")
664
535
    def PropertyChanged(self, property, value):
665
536
        "D-Bus signal"
666
537
        pass
667
538
    
668
 
    # ReceivedSecret - signal
669
 
    @dbus.service.signal(_interface)
670
 
    def ReceivedSecret(self):
671
 
        "D-Bus signal"
672
 
        pass
673
 
    
674
 
    # Rejected - signal
675
 
    @dbus.service.signal(_interface)
676
 
    def Rejected(self):
677
 
        "D-Bus signal"
678
 
        pass
679
 
    
680
539
    # SetChecker - method
681
 
    @dbus.service.method(_interface, in_signature=u"s")
 
540
    @dbus.service.method(_interface, in_signature="s")
682
541
    def SetChecker(self, checker):
683
542
        "D-Bus setter method"
684
543
        self.checker_command = checker
685
 
        # Emit D-Bus signal
686
 
        self.PropertyChanged(dbus.String(u"checker"),
687
 
                             dbus.String(self.checker_command,
688
 
                                         variant_level=1))
689
544
    
690
545
    # SetHost - method
691
 
    @dbus.service.method(_interface, in_signature=u"s")
 
546
    @dbus.service.method(_interface, in_signature="s")
692
547
    def SetHost(self, host):
693
548
        "D-Bus setter method"
694
549
        self.host = host
695
 
        # Emit D-Bus signal
696
 
        self.PropertyChanged(dbus.String(u"host"),
697
 
                             dbus.String(self.host, variant_level=1))
698
550
    
699
551
    # SetInterval - method
700
 
    @dbus.service.method(_interface, in_signature=u"t")
 
552
    @dbus.service.method(_interface, in_signature="t")
701
553
    def SetInterval(self, milliseconds):
702
 
        self.interval = datetime.timedelta(0, 0, 0, milliseconds)
703
 
        # Emit D-Bus signal
704
 
        self.PropertyChanged(dbus.String(u"interval"),
705
 
                             (dbus.UInt64(self.interval_milliseconds(),
706
 
                                          variant_level=1)))
 
554
        self.interval = datetime.timdeelta(0, 0, 0, milliseconds)
707
555
    
708
556
    # SetSecret - method
709
 
    @dbus.service.method(_interface, in_signature=u"ay",
 
557
    @dbus.service.method(_interface, in_signature="ay",
710
558
                         byte_arrays=True)
711
559
    def SetSecret(self, secret):
712
560
        "D-Bus setter method"
713
561
        self.secret = str(secret)
714
562
    
715
563
    # SetTimeout - method
716
 
    @dbus.service.method(_interface, in_signature=u"t")
 
564
    @dbus.service.method(_interface, in_signature="t")
717
565
    def SetTimeout(self, milliseconds):
718
566
        self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
719
 
        # Emit D-Bus signal
720
 
        self.PropertyChanged(dbus.String(u"timeout"),
721
 
                             (dbus.UInt64(self.timeout_milliseconds(),
722
 
                                          variant_level=1)))
723
567
    
724
 
    # Enable - method
725
 
    @dbus.service.method(_interface)
726
 
    def Enable(self):
727
 
        "D-Bus method"
728
 
        self.enable()
 
568
    # Start - method
 
569
    Start = dbus.service.method(_interface)(start)
 
570
    Start.__name__ = "Start"
729
571
    
730
572
    # StartChecker - method
731
573
    @dbus.service.method(_interface)
733
575
        "D-Bus method"
734
576
        self.start_checker()
735
577
    
736
 
    # Disable - method
 
578
    # Stop - method
737
579
    @dbus.service.method(_interface)
738
 
    def Disable(self):
 
580
    def Stop(self):
739
581
        "D-Bus method"
740
 
        self.disable()
 
582
        self.stop()
741
583
    
742
584
    # StopChecker - method
743
 
    @dbus.service.method(_interface)
744
 
    def StopChecker(self):
745
 
        self.stop_checker()
 
585
    StopChecker = dbus.service.method(_interface)(stop_checker)
 
586
    StopChecker.__name__ = "StopChecker"
746
587
    
747
588
    del _interface
748
589
 
749
590
 
750
 
class ClientHandler(socketserver.BaseRequestHandler, object):
751
 
    """A class to handle client connections.
752
 
    
753
 
    Instantiated once for each connection to handle it.
 
591
def peer_certificate(session):
 
592
    "Return the peer's OpenPGP certificate as a bytestring"
 
593
    # If not an OpenPGP certificate...
 
594
    if (gnutls.library.functions
 
595
        .gnutls_certificate_type_get(session._c_object)
 
596
        != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
597
        # ...do the normal thing
 
598
        return session.peer_certificate
 
599
    list_size = ctypes.c_uint()
 
600
    cert_list = (gnutls.library.functions
 
601
                 .gnutls_certificate_get_peers
 
602
                 (session._c_object, ctypes.byref(list_size)))
 
603
    if list_size.value == 0:
 
604
        return None
 
605
    cert = cert_list[0]
 
606
    return ctypes.string_at(cert.data, cert.size)
 
607
 
 
608
 
 
609
def fingerprint(openpgp):
 
610
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
611
    # New GnuTLS "datum" with the OpenPGP public key
 
612
    datum = (gnutls.library.types
 
613
             .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
614
                                         ctypes.POINTER
 
615
                                         (ctypes.c_ubyte)),
 
616
                             ctypes.c_uint(len(openpgp))))
 
617
    # New empty GnuTLS certificate
 
618
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
619
    (gnutls.library.functions
 
620
     .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
621
    # Import the OpenPGP public key into the certificate
 
622
    (gnutls.library.functions
 
623
     .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
624
                                gnutls.library.constants
 
625
                                .GNUTLS_OPENPGP_FMT_RAW))
 
626
    # Verify the self signature in the key
 
627
    crtverify = ctypes.c_uint()
 
628
    (gnutls.library.functions
 
629
     .gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
 
630
    if crtverify.value != 0:
 
631
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
632
        raise gnutls.errors.CertificateSecurityError("Verify failed")
 
633
    # New buffer for the fingerprint
 
634
    buf = ctypes.create_string_buffer(20)
 
635
    buf_len = ctypes.c_size_t()
 
636
    # Get the fingerprint from the certificate into the buffer
 
637
    (gnutls.library.functions
 
638
     .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
639
                                         ctypes.byref(buf_len)))
 
640
    # Deinit the certificate
 
641
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
642
    # Convert the buffer to a Python bytestring
 
643
    fpr = ctypes.string_at(buf, buf_len.value)
 
644
    # Convert the bytestring to hexadecimal notation
 
645
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
646
    return hex_fpr
 
647
 
 
648
 
 
649
class TCP_handler(SocketServer.BaseRequestHandler, object):
 
650
    """A TCP request handler class.
 
651
    Instantiated by IPv6_TCPServer for each request to handle it.
754
652
    Note: This will run in its own forked process."""
755
653
    
756
654
    def handle(self):
757
655
        logger.info(u"TCP connection from: %s",
758
656
                    unicode(self.client_address))
759
 
        logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
760
 
        # Open IPC pipe to parent process
761
 
        with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
762
 
            session = (gnutls.connection
763
 
                       .ClientSession(self.request,
764
 
                                      gnutls.connection
765
 
                                      .X509Credentials()))
766
 
            
767
 
            line = self.request.makefile().readline()
768
 
            logger.debug(u"Protocol version: %r", line)
769
 
            try:
770
 
                if int(line.strip().split()[0]) > 1:
771
 
                    raise RuntimeError
772
 
            except (ValueError, IndexError, RuntimeError), error:
773
 
                logger.error(u"Unknown protocol version: %s", error)
774
 
                return
775
 
            
776
 
            # Note: gnutls.connection.X509Credentials is really a
777
 
            # generic GnuTLS certificate credentials object so long as
778
 
            # no X.509 keys are added to it.  Therefore, we can use it
779
 
            # here despite using OpenPGP certificates.
780
 
            
781
 
            #priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
782
 
            #                      u"+AES-256-CBC", u"+SHA1",
783
 
            #                      u"+COMP-NULL", u"+CTYPE-OPENPGP",
784
 
            #                      u"+DHE-DSS"))
785
 
            # Use a fallback default, since this MUST be set.
786
 
            priority = self.server.gnutls_priority
787
 
            if priority is None:
788
 
                priority = u"NORMAL"
789
 
            (gnutls.library.functions
790
 
             .gnutls_priority_set_direct(session._c_object,
791
 
                                         priority, None))
792
 
            
793
 
            try:
794
 
                session.handshake()
795
 
            except gnutls.errors.GNUTLSError, error:
796
 
                logger.warning(u"Handshake failed: %s", error)
797
 
                # Do not run session.bye() here: the session is not
798
 
                # established.  Just abandon the request.
799
 
                return
800
 
            logger.debug(u"Handshake succeeded")
801
 
            try:
802
 
                fpr = self.fingerprint(self.peer_certificate(session))
803
 
            except (TypeError, gnutls.errors.GNUTLSError), error:
804
 
                logger.warning(u"Bad certificate: %s", error)
805
 
                session.bye()
806
 
                return
807
 
            logger.debug(u"Fingerprint: %s", fpr)
808
 
            
809
 
            for c in self.server.clients:
810
 
                if c.fingerprint == fpr:
811
 
                    client = c
812
 
                    break
813
 
            else:
814
 
                ipc.write(u"NOTFOUND %s %s\n"
815
 
                          % (fpr, unicode(self.client_address)))
816
 
                session.bye()
817
 
                return
818
 
            # Have to check if client.still_valid(), since it is
819
 
            # possible that the client timed out while establishing
820
 
            # the GnuTLS session.
821
 
            if not client.still_valid():
822
 
                ipc.write(u"INVALID %s\n" % client.name)
823
 
                session.bye()
824
 
                return
825
 
            ipc.write(u"SENDING %s\n" % client.name)
826
 
            sent_size = 0
827
 
            while sent_size < len(client.secret):
828
 
                sent = session.send(client.secret[sent_size:])
829
 
                logger.debug(u"Sent: %d, remaining: %d",
830
 
                             sent, len(client.secret)
831
 
                             - (sent_size + sent))
832
 
                sent_size += sent
833
 
            session.bye()
834
 
    
835
 
    @staticmethod
836
 
    def peer_certificate(session):
837
 
        "Return the peer's OpenPGP certificate as a bytestring"
838
 
        # If not an OpenPGP certificate...
839
 
        if (gnutls.library.functions
840
 
            .gnutls_certificate_type_get(session._c_object)
841
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
842
 
            # ...do the normal thing
843
 
            return session.peer_certificate
844
 
        list_size = ctypes.c_uint(1)
845
 
        cert_list = (gnutls.library.functions
846
 
                     .gnutls_certificate_get_peers
847
 
                     (session._c_object, ctypes.byref(list_size)))
848
 
        if not bool(cert_list) and list_size.value != 0:
849
 
            raise gnutls.errors.GNUTLSError(u"error getting peer"
850
 
                                            u" certificate")
851
 
        if list_size.value == 0:
852
 
            return None
853
 
        cert = cert_list[0]
854
 
        return ctypes.string_at(cert.data, cert.size)
855
 
    
856
 
    @staticmethod
857
 
    def fingerprint(openpgp):
858
 
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
859
 
        # New GnuTLS "datum" with the OpenPGP public key
860
 
        datum = (gnutls.library.types
861
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
862
 
                                             ctypes.POINTER
863
 
                                             (ctypes.c_ubyte)),
864
 
                                 ctypes.c_uint(len(openpgp))))
865
 
        # New empty GnuTLS certificate
866
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
867
 
        (gnutls.library.functions
868
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
869
 
        # Import the OpenPGP public key into the certificate
870
 
        (gnutls.library.functions
871
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
872
 
                                    gnutls.library.constants
873
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
874
 
        # Verify the self signature in the key
875
 
        crtverify = ctypes.c_uint()
876
 
        (gnutls.library.functions
877
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
878
 
                                         ctypes.byref(crtverify)))
879
 
        if crtverify.value != 0:
880
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
881
 
            raise (gnutls.errors.CertificateSecurityError
882
 
                   (u"Verify failed"))
883
 
        # New buffer for the fingerprint
884
 
        buf = ctypes.create_string_buffer(20)
885
 
        buf_len = ctypes.c_size_t()
886
 
        # Get the fingerprint from the certificate into the buffer
887
 
        (gnutls.library.functions
888
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
889
 
                                             ctypes.byref(buf_len)))
890
 
        # Deinit the certificate
891
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
892
 
        # Convert the buffer to a Python bytestring
893
 
        fpr = ctypes.string_at(buf, buf_len.value)
894
 
        # Convert the bytestring to hexadecimal notation
895
 
        hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
896
 
        return hex_fpr
897
 
 
898
 
 
899
 
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
900
 
    """Like socketserver.ForkingMixIn, but also pass a pipe."""
901
 
    def process_request(self, request, client_address):
902
 
        """Overrides and wraps the original process_request().
903
 
        
904
 
        This function creates a new pipe in self.pipe
905
 
        """
906
 
        self.pipe = os.pipe()
907
 
        super(ForkingMixInWithPipe,
908
 
              self).process_request(request, client_address)
909
 
        os.close(self.pipe[1])  # close write end
910
 
        self.add_pipe(self.pipe[0])
911
 
    def add_pipe(self, pipe):
912
 
        """Dummy function; override as necessary"""
913
 
        os.close(pipe)
914
 
 
915
 
 
916
 
class IPv6_TCPServer(ForkingMixInWithPipe,
917
 
                     socketserver.TCPServer, object):
918
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
919
 
    
 
657
        session = (gnutls.connection
 
658
                   .ClientSession(self.request,
 
659
                                  gnutls.connection
 
660
                                  .X509Credentials()))
 
661
        
 
662
        line = self.request.makefile().readline()
 
663
        logger.debug(u"Protocol version: %r", line)
 
664
        try:
 
665
            if int(line.strip().split()[0]) > 1:
 
666
                raise RuntimeError
 
667
        except (ValueError, IndexError, RuntimeError), error:
 
668
            logger.error(u"Unknown protocol version: %s", error)
 
669
            return
 
670
        
 
671
        # Note: gnutls.connection.X509Credentials is really a generic
 
672
        # GnuTLS certificate credentials object so long as no X.509
 
673
        # keys are added to it.  Therefore, we can use it here despite
 
674
        # using OpenPGP certificates.
 
675
        
 
676
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
 
677
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
678
        #                "+DHE-DSS"))
 
679
        # Use a fallback default, since this MUST be set.
 
680
        priority = self.server.settings.get("priority", "NORMAL")
 
681
        (gnutls.library.functions
 
682
         .gnutls_priority_set_direct(session._c_object,
 
683
                                     priority, None))
 
684
        
 
685
        try:
 
686
            session.handshake()
 
687
        except gnutls.errors.GNUTLSError, error:
 
688
            logger.warning(u"Handshake failed: %s", error)
 
689
            # Do not run session.bye() here: the session is not
 
690
            # established.  Just abandon the request.
 
691
            return
 
692
        try:
 
693
            fpr = fingerprint(peer_certificate(session))
 
694
        except (TypeError, gnutls.errors.GNUTLSError), error:
 
695
            logger.warning(u"Bad certificate: %s", error)
 
696
            session.bye()
 
697
            return
 
698
        logger.debug(u"Fingerprint: %s", fpr)
 
699
        for c in self.server.clients:
 
700
            if c.fingerprint == fpr:
 
701
                client = c
 
702
                break
 
703
        else:
 
704
            logger.warning(u"Client not found for fingerprint: %s",
 
705
                           fpr)
 
706
            session.bye()
 
707
            return
 
708
        # Have to check if client.still_valid(), since it is possible
 
709
        # that the client timed out while establishing the GnuTLS
 
710
        # session.
 
711
        if not client.still_valid():
 
712
            logger.warning(u"Client %(name)s is invalid",
 
713
                           vars(client))
 
714
            session.bye()
 
715
            return
 
716
        ## This won't work here, since we're in a fork.
 
717
        # client.bump_timeout()
 
718
        sent_size = 0
 
719
        while sent_size < len(client.secret):
 
720
            sent = session.send(client.secret[sent_size:])
 
721
            logger.debug(u"Sent: %d, remaining: %d",
 
722
                         sent, len(client.secret)
 
723
                         - (sent_size + sent))
 
724
            sent_size += sent
 
725
        session.bye()
 
726
 
 
727
 
 
728
class IPv6_TCPServer(SocketServer.ForkingMixIn,
 
729
                     SocketServer.TCPServer, object):
 
730
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
920
731
    Attributes:
 
732
        settings:       Server settings
 
733
        clients:        Set() of Client objects
921
734
        enabled:        Boolean; whether this server is activated yet
922
 
        interface:      None or a network interface name (string)
923
 
        use_ipv6:       Boolean; to use IPv6 or not
924
735
    """
925
 
    def __init__(self, server_address, RequestHandlerClass,
926
 
                 interface=None, use_ipv6=True):
927
 
        self.interface = interface
928
 
        if use_ipv6:
929
 
            self.address_family = socket.AF_INET6
930
 
        socketserver.TCPServer.__init__(self, server_address,
931
 
                                        RequestHandlerClass)
 
736
    address_family = socket.AF_INET6
 
737
    def __init__(self, *args, **kwargs):
 
738
        if "settings" in kwargs:
 
739
            self.settings = kwargs["settings"]
 
740
            del kwargs["settings"]
 
741
        if "clients" in kwargs:
 
742
            self.clients = kwargs["clients"]
 
743
            del kwargs["clients"]
 
744
        self.enabled = False
 
745
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
932
746
    def server_bind(self):
933
747
        """This overrides the normal server_bind() function
934
748
        to bind to an interface if one was specified, and also NOT to
935
749
        bind to an address or port if they were not specified."""
936
 
        if self.interface is not None:
937
 
            if SO_BINDTODEVICE is None:
938
 
                logger.error(u"SO_BINDTODEVICE does not exist;"
939
 
                             u" cannot bind to interface %s",
940
 
                             self.interface)
941
 
            else:
942
 
                try:
943
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
944
 
                                           SO_BINDTODEVICE,
945
 
                                           str(self.interface
946
 
                                               + u'\0'))
947
 
                except socket.error, error:
948
 
                    if error[0] == errno.EPERM:
949
 
                        logger.error(u"No permission to"
950
 
                                     u" bind to interface %s",
951
 
                                     self.interface)
952
 
                    elif error[0] == errno.ENOPROTOOPT:
953
 
                        logger.error(u"SO_BINDTODEVICE not available;"
954
 
                                     u" cannot bind to interface %s",
955
 
                                     self.interface)
956
 
                    else:
957
 
                        raise
 
750
        if self.settings["interface"]:
 
751
            # 25 is from /usr/include/asm-i486/socket.h
 
752
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
753
            try:
 
754
                self.socket.setsockopt(socket.SOL_SOCKET,
 
755
                                       SO_BINDTODEVICE,
 
756
                                       self.settings["interface"])
 
757
            except socket.error, error:
 
758
                if error[0] == errno.EPERM:
 
759
                    logger.error(u"No permission to"
 
760
                                 u" bind to interface %s",
 
761
                                 self.settings["interface"])
 
762
                else:
 
763
                    raise error
958
764
        # Only bind(2) the socket if we really need to.
959
765
        if self.server_address[0] or self.server_address[1]:
960
766
            if not self.server_address[0]:
961
 
                if self.address_family == socket.AF_INET6:
962
 
                    any_address = u"::" # in6addr_any
963
 
                else:
964
 
                    any_address = socket.INADDR_ANY
965
 
                self.server_address = (any_address,
 
767
                in6addr_any = "::"
 
768
                self.server_address = (in6addr_any,
966
769
                                       self.server_address[1])
967
770
            elif not self.server_address[1]:
968
771
                self.server_address = (self.server_address[0],
969
772
                                       0)
970
 
#                 if self.interface:
 
773
#                 if self.settings["interface"]:
971
774
#                     self.server_address = (self.server_address[0],
972
775
#                                            0, # port
973
776
#                                            0, # flowinfo
974
777
#                                            if_nametoindex
975
 
#                                            (self.interface))
976
 
            return socketserver.TCPServer.server_bind(self)
977
 
 
978
 
 
979
 
class MandosServer(IPv6_TCPServer):
980
 
    """Mandos server.
981
 
    
982
 
    Attributes:
983
 
        clients:        set of Client objects
984
 
        gnutls_priority GnuTLS priority string
985
 
        use_dbus:       Boolean; to emit D-Bus signals or not
986
 
        clients:        set of Client objects
987
 
        gnutls_priority GnuTLS priority string
988
 
        use_dbus:       Boolean; to emit D-Bus signals or not
989
 
    
990
 
    Assumes a gobject.MainLoop event loop.
991
 
    """
992
 
    def __init__(self, server_address, RequestHandlerClass,
993
 
                 interface=None, use_ipv6=True, clients=None,
994
 
                 gnutls_priority=None, use_dbus=True):
995
 
        self.enabled = False
996
 
        self.clients = clients
997
 
        if self.clients is None:
998
 
            self.clients = set()
999
 
        self.use_dbus = use_dbus
1000
 
        self.gnutls_priority = gnutls_priority
1001
 
        IPv6_TCPServer.__init__(self, server_address,
1002
 
                                RequestHandlerClass,
1003
 
                                interface = interface,
1004
 
                                use_ipv6 = use_ipv6)
 
778
#                                            (self.settings
 
779
#                                             ["interface"]))
 
780
            return super(IPv6_TCPServer, self).server_bind()
1005
781
    def server_activate(self):
1006
782
        if self.enabled:
1007
 
            return socketserver.TCPServer.server_activate(self)
 
783
            return super(IPv6_TCPServer, self).server_activate()
1008
784
    def enable(self):
1009
785
        self.enabled = True
1010
 
    def add_pipe(self, pipe):
1011
 
        # Call "handle_ipc" for both data and EOF events
1012
 
        gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1013
 
                             self.handle_ipc)
1014
 
    def handle_ipc(self, source, condition, file_objects={}):
1015
 
        condition_names = {
1016
 
            gobject.IO_IN: u"IN",   # There is data to read.
1017
 
            gobject.IO_OUT: u"OUT", # Data can be written (without
1018
 
                                    # blocking).
1019
 
            gobject.IO_PRI: u"PRI", # There is urgent data to read.
1020
 
            gobject.IO_ERR: u"ERR", # Error condition.
1021
 
            gobject.IO_HUP: u"HUP"  # Hung up (the connection has been
1022
 
                                    # broken, usually for pipes and
1023
 
                                    # sockets).
1024
 
            }
1025
 
        conditions_string = ' | '.join(name
1026
 
                                       for cond, name in
1027
 
                                       condition_names.iteritems()
1028
 
                                       if cond & condition)
1029
 
        logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1030
 
                     conditions_string)
1031
 
        
1032
 
        # Turn the pipe file descriptor into a Python file object
1033
 
        if source not in file_objects:
1034
 
            file_objects[source] = os.fdopen(source, u"r", 1)
1035
 
        
1036
 
        # Read a line from the file object
1037
 
        cmdline = file_objects[source].readline()
1038
 
        if not cmdline:             # Empty line means end of file
1039
 
            # close the IPC pipe
1040
 
            file_objects[source].close()
1041
 
            del file_objects[source]
1042
 
            
1043
 
            # Stop calling this function
1044
 
            return False
1045
 
        
1046
 
        logger.debug(u"IPC command: %r", cmdline)
1047
 
        
1048
 
        # Parse and act on command
1049
 
        cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1050
 
        
1051
 
        if cmd == u"NOTFOUND":
1052
 
            logger.warning(u"Client not found for fingerprint: %s",
1053
 
                           args)
1054
 
            if self.use_dbus:
1055
 
                # Emit D-Bus signal
1056
 
                mandos_dbus_service.ClientNotFound(args)
1057
 
        elif cmd == u"INVALID":
1058
 
            for client in self.clients:
1059
 
                if client.name == args:
1060
 
                    logger.warning(u"Client %s is invalid", args)
1061
 
                    if self.use_dbus:
1062
 
                        # Emit D-Bus signal
1063
 
                        client.Rejected()
1064
 
                    break
1065
 
            else:
1066
 
                logger.error(u"Unknown client %s is invalid", args)
1067
 
        elif cmd == u"SENDING":
1068
 
            for client in self.clients:
1069
 
                if client.name == args:
1070
 
                    logger.info(u"Sending secret to %s", client.name)
1071
 
                    client.checked_ok()
1072
 
                    if self.use_dbus:
1073
 
                        # Emit D-Bus signal
1074
 
                        client.ReceivedSecret()
1075
 
                    break
1076
 
            else:
1077
 
                logger.error(u"Sending secret to unknown client %s",
1078
 
                             args)
1079
 
        else:
1080
 
            logger.error(u"Unknown IPC command: %r", cmdline)
1081
 
        
1082
 
        # Keep calling this function
1083
 
        return True
1084
786
 
1085
787
 
1086
788
def string_to_delta(interval):
1087
789
    """Parse a string and return a datetime.timedelta
1088
 
    
1089
 
    >>> string_to_delta(u'7d')
 
790
 
 
791
    >>> string_to_delta('7d')
1090
792
    datetime.timedelta(7)
1091
 
    >>> string_to_delta(u'60s')
 
793
    >>> string_to_delta('60s')
1092
794
    datetime.timedelta(0, 60)
1093
 
    >>> string_to_delta(u'60m')
 
795
    >>> string_to_delta('60m')
1094
796
    datetime.timedelta(0, 3600)
1095
 
    >>> string_to_delta(u'24h')
 
797
    >>> string_to_delta('24h')
1096
798
    datetime.timedelta(1)
1097
799
    >>> string_to_delta(u'1w')
1098
800
    datetime.timedelta(7)
1099
 
    >>> string_to_delta(u'5m 30s')
 
801
    >>> string_to_delta('5m 30s')
1100
802
    datetime.timedelta(0, 330)
1101
803
    """
1102
804
    timevalue = datetime.timedelta(0)
1122
824
    return timevalue
1123
825
 
1124
826
 
 
827
def server_state_changed(state):
 
828
    """Derived from the Avahi example code"""
 
829
    if state == avahi.SERVER_COLLISION:
 
830
        logger.error(u"Zeroconf server name collision")
 
831
        service.remove()
 
832
    elif state == avahi.SERVER_RUNNING:
 
833
        service.add()
 
834
 
 
835
 
 
836
def entry_group_state_changed(state, error):
 
837
    """Derived from the Avahi example code"""
 
838
    logger.debug(u"Avahi state change: %i", state)
 
839
    
 
840
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
841
        logger.debug(u"Zeroconf service established.")
 
842
    elif state == avahi.ENTRY_GROUP_COLLISION:
 
843
        logger.warning(u"Zeroconf service name collision.")
 
844
        service.rename()
 
845
    elif state == avahi.ENTRY_GROUP_FAILURE:
 
846
        logger.critical(u"Avahi: Error in group state changed %s",
 
847
                        unicode(error))
 
848
        raise AvahiGroupError("State changed: %s", str(error))
 
849
 
1125
850
def if_nametoindex(interface):
1126
 
    """Call the C function if_nametoindex(), or equivalent
1127
 
    
1128
 
    Note: This function cannot accept a unicode string."""
 
851
    """Call the C function if_nametoindex(), or equivalent"""
1129
852
    global if_nametoindex
1130
853
    try:
1131
854
        if_nametoindex = (ctypes.cdll.LoadLibrary
1132
 
                          (ctypes.util.find_library(u"c"))
 
855
                          (ctypes.util.find_library("c"))
1133
856
                          .if_nametoindex)
1134
857
    except (OSError, AttributeError):
1135
 
        logger.warning(u"Doing if_nametoindex the hard way")
 
858
        if "struct" not in sys.modules:
 
859
            import struct
 
860
        if "fcntl" not in sys.modules:
 
861
            import fcntl
1136
862
        def if_nametoindex(interface):
1137
863
            "Get an interface index the hard way, i.e. using fcntl()"
1138
864
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1139
865
            with closing(socket.socket()) as s:
1140
866
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1141
 
                                    struct.pack(str(u"16s16x"),
1142
 
                                                interface))
1143
 
            interface_index = struct.unpack(str(u"I"),
1144
 
                                            ifreq[16:20])[0]
 
867
                                    struct.pack("16s16x", interface))
 
868
            interface_index = struct.unpack("I", ifreq[16:20])[0]
1145
869
            return interface_index
1146
870
    return if_nametoindex(interface)
1147
871
 
1148
872
 
1149
873
def daemon(nochdir = False, noclose = False):
1150
874
    """See daemon(3).  Standard BSD Unix function.
1151
 
    
1152
875
    This should really exist as os.daemon, but it doesn't (yet)."""
1153
876
    if os.fork():
1154
877
        sys.exit()
1155
878
    os.setsid()
1156
879
    if not nochdir:
1157
 
        os.chdir(u"/")
 
880
        os.chdir("/")
1158
881
    if os.fork():
1159
882
        sys.exit()
1160
883
    if not noclose:
1162
885
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1163
886
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1164
887
            raise OSError(errno.ENODEV,
1165
 
                          u"/dev/null not a character device")
 
888
                          "/dev/null not a character device")
1166
889
        os.dup2(null, sys.stdin.fileno())
1167
890
        os.dup2(null, sys.stdout.fileno())
1168
891
        os.dup2(null, sys.stderr.fileno())
1171
894
 
1172
895
 
1173
896
def main():
1174
 
    
1175
 
    ######################################################################
1176
 
    # Parsing of options, both command line and config file
1177
 
    
1178
 
    parser = optparse.OptionParser(version = "%%prog %s" % version)
1179
 
    parser.add_option("-i", u"--interface", type=u"string",
1180
 
                      metavar="IF", help=u"Bind to interface IF")
1181
 
    parser.add_option("-a", u"--address", type=u"string",
1182
 
                      help=u"Address to listen for requests on")
1183
 
    parser.add_option("-p", u"--port", type=u"int",
1184
 
                      help=u"Port number to receive requests on")
1185
 
    parser.add_option("--check", action=u"store_true",
1186
 
                      help=u"Run self-test")
1187
 
    parser.add_option("--debug", action=u"store_true",
1188
 
                      help=u"Debug mode; run in foreground and log to"
1189
 
                      u" terminal")
1190
 
    parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1191
 
                      u" priority string (see GnuTLS documentation)")
1192
 
    parser.add_option("--servicename", type=u"string",
1193
 
                      metavar=u"NAME", help=u"Zeroconf service name")
1194
 
    parser.add_option("--configdir", type=u"string",
1195
 
                      default=u"/etc/mandos", metavar=u"DIR",
1196
 
                      help=u"Directory to search for configuration"
1197
 
                      u" files")
1198
 
    parser.add_option("--no-dbus", action=u"store_false",
1199
 
                      dest=u"use_dbus",
1200
 
                      help=optparse.SUPPRESS_HELP) # XXX: Not done yet
1201
 
    parser.add_option("--no-ipv6", action=u"store_false",
1202
 
                      dest=u"use_ipv6", help=u"Do not use IPv6")
 
897
    parser = OptionParser(version = "%%prog %s" % version)
 
898
    parser.add_option("-i", "--interface", type="string",
 
899
                      metavar="IF", help="Bind to interface IF")
 
900
    parser.add_option("-a", "--address", type="string",
 
901
                      help="Address to listen for requests on")
 
902
    parser.add_option("-p", "--port", type="int",
 
903
                      help="Port number to receive requests on")
 
904
    parser.add_option("--check", action="store_true", default=False,
 
905
                      help="Run self-test")
 
906
    parser.add_option("--debug", action="store_true",
 
907
                      help="Debug mode; run in foreground and log to"
 
908
                      " terminal")
 
909
    parser.add_option("--priority", type="string", help="GnuTLS"
 
910
                      " priority string (see GnuTLS documentation)")
 
911
    parser.add_option("--servicename", type="string", metavar="NAME",
 
912
                      help="Zeroconf service name")
 
913
    parser.add_option("--configdir", type="string",
 
914
                      default="/etc/mandos", metavar="DIR",
 
915
                      help="Directory to search for configuration"
 
916
                      " files")
1203
917
    options = parser.parse_args()[0]
1204
918
    
1205
919
    if options.check:
1208
922
        sys.exit()
1209
923
    
1210
924
    # Default values for config file for server-global settings
1211
 
    server_defaults = { u"interface": u"",
1212
 
                        u"address": u"",
1213
 
                        u"port": u"",
1214
 
                        u"debug": u"False",
1215
 
                        u"priority":
1216
 
                        u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1217
 
                        u"servicename": u"Mandos",
1218
 
                        u"use_dbus": u"True",
1219
 
                        u"use_ipv6": u"True",
 
925
    server_defaults = { "interface": "",
 
926
                        "address": "",
 
927
                        "port": "",
 
928
                        "debug": "False",
 
929
                        "priority":
 
930
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
931
                        "servicename": "Mandos",
1220
932
                        }
1221
933
    
1222
934
    # Parse config file for server-global settings
1223
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
935
    server_config = ConfigParser.SafeConfigParser(server_defaults)
1224
936
    del server_defaults
1225
 
    server_config.read(os.path.join(options.configdir,
1226
 
                                    u"mandos.conf"))
 
937
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
1227
938
    # Convert the SafeConfigParser object to a dict
1228
939
    server_settings = server_config.defaults()
1229
 
    # Use the appropriate methods on the non-string config options
1230
 
    for option in (u"debug", u"use_dbus", u"use_ipv6"):
1231
 
        server_settings[option] = server_config.getboolean(u"DEFAULT",
1232
 
                                                           option)
1233
 
    if server_settings["port"]:
1234
 
        server_settings["port"] = server_config.getint(u"DEFAULT",
1235
 
                                                       u"port")
 
940
    # Use getboolean on the boolean config option
 
941
    server_settings["debug"] = (server_config.getboolean
 
942
                                ("DEFAULT", "debug"))
1236
943
    del server_config
1237
944
    
1238
945
    # Override the settings from the config file with command line
1239
946
    # options, if set.
1240
 
    for option in (u"interface", u"address", u"port", u"debug",
1241
 
                   u"priority", u"servicename", u"configdir",
1242
 
                   u"use_dbus", u"use_ipv6"):
 
947
    for option in ("interface", "address", "port", "debug",
 
948
                   "priority", "servicename", "configdir"):
1243
949
        value = getattr(options, option)
1244
950
        if value is not None:
1245
951
            server_settings[option] = value
1246
952
    del options
1247
 
    # Force all strings to be unicode
1248
 
    for option in server_settings.keys():
1249
 
        if type(server_settings[option]) is str:
1250
 
            server_settings[option] = unicode(server_settings[option])
1251
953
    # Now we have our good server settings in "server_settings"
1252
954
    
1253
 
    ##################################################################
1254
 
    
1255
 
    # For convenience
1256
 
    debug = server_settings[u"debug"]
1257
 
    use_dbus = server_settings[u"use_dbus"]
1258
 
    use_dbus = False            # XXX: Not done yet
1259
 
    use_ipv6 = server_settings[u"use_ipv6"]
 
955
    debug = server_settings["debug"]
1260
956
    
1261
957
    if not debug:
1262
958
        syslogger.setLevel(logging.WARNING)
1263
959
        console.setLevel(logging.WARNING)
1264
960
    
1265
 
    if server_settings[u"servicename"] != u"Mandos":
 
961
    if server_settings["servicename"] != "Mandos":
1266
962
        syslogger.setFormatter(logging.Formatter
1267
 
                               (u'Mandos (%s) [%%(process)d]:'
1268
 
                                u' %%(levelname)s: %%(message)s'
1269
 
                                % server_settings[u"servicename"]))
 
963
                               ('Mandos (%s): %%(levelname)s:'
 
964
                                ' %%(message)s'
 
965
                                % server_settings["servicename"]))
1270
966
    
1271
967
    # Parse config file with clients
1272
 
    client_defaults = { u"timeout": u"1h",
1273
 
                        u"interval": u"5m",
1274
 
                        u"checker": u"fping -q -- %%(host)s",
1275
 
                        u"host": u"",
 
968
    client_defaults = { "timeout": "1h",
 
969
                        "interval": "5m",
 
970
                        "checker": "fping -q -- %(host)s",
 
971
                        "host": "",
1276
972
                        }
1277
 
    client_config = configparser.SafeConfigParser(client_defaults)
1278
 
    client_config.read(os.path.join(server_settings[u"configdir"],
1279
 
                                    u"clients.conf"))
1280
 
    
1281
 
    global mandos_dbus_service
1282
 
    mandos_dbus_service = None
1283
 
    
1284
 
    tcp_server = MandosServer((server_settings[u"address"],
1285
 
                               server_settings[u"port"]),
1286
 
                              ClientHandler,
1287
 
                              interface=server_settings[u"interface"],
1288
 
                              use_ipv6=use_ipv6,
1289
 
                              gnutls_priority=
1290
 
                              server_settings[u"priority"],
1291
 
                              use_dbus=use_dbus)
1292
 
    pidfilename = u"/var/run/mandos.pid"
1293
 
    try:
1294
 
        pidfile = open(pidfilename, u"w")
1295
 
    except IOError:
1296
 
        logger.error(u"Could not open file %r", pidfilename)
1297
 
    
1298
 
    try:
1299
 
        uid = pwd.getpwnam(u"_mandos").pw_uid
1300
 
        gid = pwd.getpwnam(u"_mandos").pw_gid
 
973
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
974
    client_config.read(os.path.join(server_settings["configdir"],
 
975
                                    "clients.conf"))
 
976
    
 
977
    clients = Set()
 
978
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
979
                                 server_settings["port"]),
 
980
                                TCP_handler,
 
981
                                settings=server_settings,
 
982
                                clients=clients)
 
983
    pidfilename = "/var/run/mandos.pid"
 
984
    try:
 
985
        pidfile = open(pidfilename, "w")
 
986
    except IOError, error:
 
987
        logger.error("Could not open file %r", pidfilename)
 
988
    
 
989
    try:
 
990
        uid = pwd.getpwnam("_mandos").pw_uid
1301
991
    except KeyError:
1302
992
        try:
1303
 
            uid = pwd.getpwnam(u"mandos").pw_uid
1304
 
            gid = pwd.getpwnam(u"mandos").pw_gid
 
993
            uid = pwd.getpwnam("mandos").pw_uid
1305
994
        except KeyError:
1306
995
            try:
1307
 
                uid = pwd.getpwnam(u"nobody").pw_uid
1308
 
                gid = pwd.getpwnam(u"nobody").pw_gid
 
996
                uid = pwd.getpwnam("nobody").pw_uid
1309
997
            except KeyError:
1310
998
                uid = 65534
 
999
    try:
 
1000
        gid = pwd.getpwnam("_mandos").pw_gid
 
1001
    except KeyError:
 
1002
        try:
 
1003
            gid = pwd.getpwnam("mandos").pw_gid
 
1004
        except KeyError:
 
1005
            try:
 
1006
                gid = pwd.getpwnam("nogroup").pw_gid
 
1007
            except KeyError:
1311
1008
                gid = 65534
1312
1009
    try:
 
1010
        os.setuid(uid)
1313
1011
        os.setgid(gid)
1314
 
        os.setuid(uid)
1315
1012
    except OSError, error:
1316
1013
        if error[0] != errno.EPERM:
1317
1014
            raise error
1318
1015
    
1319
 
    # Enable all possible GnuTLS debugging
1320
 
    if debug:
1321
 
        # "Use a log level over 10 to enable all debugging options."
1322
 
        # - GnuTLS manual
1323
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
1324
 
        
1325
 
        @gnutls.library.types.gnutls_log_func
1326
 
        def debug_gnutls(level, string):
1327
 
            logger.debug(u"GnuTLS: %s", string[:-1])
1328
 
        
1329
 
        (gnutls.library.functions
1330
 
         .gnutls_global_set_log_function(debug_gnutls))
 
1016
    global service
 
1017
    service = AvahiService(name = server_settings["servicename"],
 
1018
                           servicetype = "_mandos._tcp", )
 
1019
    if server_settings["interface"]:
 
1020
        service.interface = (if_nametoindex
 
1021
                             (server_settings["interface"]))
1331
1022
    
1332
1023
    global main_loop
 
1024
    global bus
 
1025
    global server
1333
1026
    # From the Avahi example code
1334
1027
    DBusGMainLoop(set_as_default=True )
1335
1028
    main_loop = gobject.MainLoop()
1336
1029
    bus = dbus.SystemBus()
 
1030
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
 
1031
                                           avahi.DBUS_PATH_SERVER),
 
1032
                            avahi.DBUS_INTERFACE_SERVER)
1337
1033
    # End of Avahi example code
1338
 
    if use_dbus:
1339
 
        bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1340
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1341
 
    service = AvahiService(name = server_settings[u"servicename"],
1342
 
                           servicetype = u"_mandos._tcp",
1343
 
                           protocol = protocol, bus = bus)
1344
 
    if server_settings["interface"]:
1345
 
        service.interface = (if_nametoindex
1346
 
                             (str(server_settings[u"interface"])))
 
1034
    bus_name = dbus.service.BusName(u"org.mandos-system.Mandos", bus)
1347
1035
    
1348
 
    client_class = Client
1349
 
    if use_dbus:
1350
 
        client_class = functools.partial(ClientDBus, bus = bus)
1351
 
    tcp_server.clients.update(set(
1352
 
            client_class(name = section,
1353
 
                         config= dict(client_config.items(section)))
1354
 
            for section in client_config.sections()))
1355
 
    if not tcp_server.clients:
1356
 
        logger.warning(u"No clients defined")
 
1036
    clients.update(Set(Client(name = section,
 
1037
                              config
 
1038
                              = dict(client_config.items(section)))
 
1039
                       for section in client_config.sections()))
 
1040
    if not clients:
 
1041
        logger.critical(u"No clients defined")
 
1042
        sys.exit(1)
1357
1043
    
1358
1044
    if debug:
1359
1045
        # Redirect stdin so all checkers get /dev/null
1368
1054
        daemon()
1369
1055
    
1370
1056
    try:
1371
 
        with closing(pidfile):
1372
 
            pid = os.getpid()
1373
 
            pidfile.write(str(pid) + "\n")
 
1057
        pid = os.getpid()
 
1058
        pidfile.write(str(pid) + "\n")
 
1059
        pidfile.close()
1374
1060
        del pidfile
1375
1061
    except IOError:
1376
1062
        logger.error(u"Could not write to file %r with PID %d",
1382
1068
    
1383
1069
    def cleanup():
1384
1070
        "Cleanup function; run on exit"
1385
 
        service.cleanup()
 
1071
        global group
 
1072
        # From the Avahi example code
 
1073
        if not group is None:
 
1074
            group.Free()
 
1075
            group = None
 
1076
        # End of Avahi example code
1386
1077
        
1387
 
        while tcp_server.clients:
1388
 
            client = tcp_server.clients.pop()
1389
 
            client.disable_hook = None
1390
 
            client.disable()
 
1078
        while clients:
 
1079
            client = clients.pop()
 
1080
            client.stop_hook = None
 
1081
            client.stop()
1391
1082
    
1392
1083
    atexit.register(cleanup)
1393
1084
    
1396
1087
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1397
1088
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1398
1089
    
1399
 
    if use_dbus:
1400
 
        class MandosDBusService(dbus.service.Object):
1401
 
            """A D-Bus proxy object"""
1402
 
            def __init__(self):
1403
 
                dbus.service.Object.__init__(self, bus, u"/")
1404
 
            _interface = u"se.bsnet.fukt.Mandos"
1405
 
            
1406
 
            @dbus.service.signal(_interface, signature=u"oa{sv}")
1407
 
            def ClientAdded(self, objpath, properties):
1408
 
                "D-Bus signal"
1409
 
                pass
1410
 
            
1411
 
            @dbus.service.signal(_interface, signature=u"s")
1412
 
            def ClientNotFound(self, fingerprint):
1413
 
                "D-Bus signal"
1414
 
                pass
1415
 
            
1416
 
            @dbus.service.signal(_interface, signature=u"os")
1417
 
            def ClientRemoved(self, objpath, name):
1418
 
                "D-Bus signal"
1419
 
                pass
1420
 
            
1421
 
            @dbus.service.method(_interface, out_signature=u"ao")
1422
 
            def GetAllClients(self):
1423
 
                "D-Bus method"
1424
 
                return dbus.Array(c.dbus_object_path
1425
 
                                  for c in tcp_server.clients)
1426
 
            
1427
 
            @dbus.service.method(_interface,
1428
 
                                 out_signature=u"a{oa{sv}}")
1429
 
            def GetAllClientsWithProperties(self):
1430
 
                "D-Bus method"
1431
 
                return dbus.Dictionary(
1432
 
                    ((c.dbus_object_path, c.GetAllProperties())
1433
 
                     for c in tcp_server.clients),
1434
 
                    signature=u"oa{sv}")
1435
 
            
1436
 
            @dbus.service.method(_interface, in_signature=u"o")
1437
 
            def RemoveClient(self, object_path):
1438
 
                "D-Bus method"
1439
 
                for c in tcp_server.clients:
1440
 
                    if c.dbus_object_path == object_path:
1441
 
                        tcp_server.clients.remove(c)
1442
 
                        c.remove_from_connection()
1443
 
                        # Don't signal anything except ClientRemoved
1444
 
                        c.disable(signal=False)
1445
 
                        # Emit D-Bus signal
1446
 
                        self.ClientRemoved(object_path, c.name)
1447
 
                        return
1448
 
                raise KeyError
1449
 
            
1450
 
            del _interface
1451
 
        
1452
 
        mandos_dbus_service = MandosDBusService()
1453
 
    
1454
 
    for client in tcp_server.clients:
1455
 
        if use_dbus:
1456
 
            # Emit D-Bus signal
1457
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path,
1458
 
                                            client.GetAllProperties())
1459
 
        client.enable()
 
1090
    class MandosServer(dbus.service.Object):
 
1091
        """A D-Bus proxy object"""
 
1092
        def __init__(self):
 
1093
            dbus.service.Object.__init__(self, bus,
 
1094
                                         "/Mandos")
 
1095
        _interface = u"org.mandos_system.Mandos"
 
1096
        
 
1097
        @dbus.service.signal(_interface, signature="oa{sv}")
 
1098
        def ClientAdded(self, objpath, properties):
 
1099
            "D-Bus signal"
 
1100
            pass
 
1101
        
 
1102
        @dbus.service.signal(_interface, signature="o")
 
1103
        def ClientRemoved(self, objpath):
 
1104
            "D-Bus signal"
 
1105
            pass
 
1106
        
 
1107
        @dbus.service.method(_interface, out_signature="ao")
 
1108
        def GetAllClients(self):
 
1109
            return dbus.Array(c.dbus_object_path for c in clients)
 
1110
        
 
1111
        @dbus.service.method(_interface, out_signature="a{oa{sv}}")
 
1112
        def GetAllClientsWithProperties(self):
 
1113
            return dbus.Dictionary(
 
1114
                ((c.dbus_object_path, c.GetAllProperties())
 
1115
                 for c in clients),
 
1116
                signature="oa{sv}")
 
1117
        
 
1118
        @dbus.service.method(_interface, in_signature="o")
 
1119
        def RemoveClient(self, object_path):
 
1120
            for c in clients:
 
1121
                if c.dbus_object_path == object_path:
 
1122
                    c.stop()
 
1123
                    clients.remove(c)
 
1124
                    return
 
1125
            raise KeyError
 
1126
        
 
1127
        del _interface
 
1128
    
 
1129
    mandos_server = MandosServer()
 
1130
    
 
1131
    for client in clients:
 
1132
        # Emit D-Bus signal
 
1133
        mandos_server.ClientAdded(client.dbus_object_path,
 
1134
                                  client.GetAllProperties())
 
1135
        client.start()
1460
1136
    
1461
1137
    tcp_server.enable()
1462
1138
    tcp_server.server_activate()
1463
1139
    
1464
1140
    # Find out what port we got
1465
1141
    service.port = tcp_server.socket.getsockname()[1]
1466
 
    if use_ipv6:
1467
 
        logger.info(u"Now listening on address %r, port %d,"
1468
 
                    " flowinfo %d, scope_id %d"
1469
 
                    % tcp_server.socket.getsockname())
1470
 
    else:                       # IPv4
1471
 
        logger.info(u"Now listening on address %r, port %d"
1472
 
                    % tcp_server.socket.getsockname())
 
1142
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
 
1143
                u" scope_id %d" % tcp_server.socket.getsockname())
1473
1144
    
1474
1145
    #service.interface = tcp_server.socket.getsockname()[3]
1475
1146
    
1476
1147
    try:
1477
1148
        # From the Avahi example code
 
1149
        server.connect_to_signal("StateChanged", server_state_changed)
1478
1150
        try:
1479
 
            service.activate()
 
1151
            server_state_changed(server.GetState())
1480
1152
        except dbus.exceptions.DBusException, error:
1481
1153
            logger.critical(u"DBusException: %s", error)
1482
1154
            sys.exit(1)
1490
1162
        logger.debug(u"Starting main loop")
1491
1163
        main_loop.run()
1492
1164
    except AvahiError, error:
1493
 
        logger.critical(u"AvahiError: %s", error)
 
1165
        logger.critical(u"AvahiError: %s" + unicode(error))
1494
1166
        sys.exit(1)
1495
1167
    except KeyboardInterrupt:
1496
1168
        if debug:
1497
 
            print >> sys.stderr
1498
 
        logger.debug(u"Server received KeyboardInterrupt")
1499
 
    logger.debug(u"Server exiting")
 
1169
            print
1500
1170
 
1501
1171
if __name__ == '__main__':
1502
1172
    main()