/mandos/trunk

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

« back to all changes in this revision

Viewing changes to server.py

  • Committer: Teddy Hogeborn
  • Date: 2008-07-21 01:50:31 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080721015031-ivjiclli2j06hwgs
* Makefile: Include targets for all binaries.

* plugins.d/Makefile: Do nothing but call the parent Makefile.

* server.py: Added copyright statement and information.
  (Client.__init__): Added doc string.
  (Client.stop): Bug fix: Only log message if stopping for the first
                 time.  Check if the "stop_initiator_tag" and
                 "checker_initiator_tag" attributes exist before using
                 them.
  (Client.__del__): Call self.stop() instead of doing things here.
  (Client.checker_callback): Set self.checker_callback_tag and
                             self.checker to None unconditionally and
                             immediately.
  (Client.stop_checker): Added some checks to handle multiple calls.
  (tcp_handler.handle): Use "self.server.clients" instead of "clients".
  (__main__): Moved all code to the "main" function.
  (main): New.  New option "--address".  Instantiate IPv6_TCPServer
          with "options.address".  Log before starting main loop.
  (main.cleanup) Use "clients.pop()" to remove clients from the set as
                 they are stopped.

Show diffs side-by-side

added added

removed removed

Lines of Context:
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
 
# methods "add" and "remove" in the "AvahiService" class, the
10
 
# "server_state_changed" and "entry_group_state_changed" functions,
11
 
# and some lines in "main".
 
9
# following functions: "add_service", "remove_service",
 
10
# "server_state_changed", "entry_group_state_changed", and some lines
 
11
# in "main".
12
12
13
 
# Everything else is
14
 
# Copyright © 2008,2009 Teddy Hogeborn
15
 
# Copyright © 2008,2009 Björn Påhlsson
 
13
# Everything else is Copyright © 2007-2008 Teddy Hogeborn and Björn
 
14
# Påhlsson.
16
15
17
16
# This program is free software: you can redistribute it and/or modify
18
17
# it under the terms of the GNU General Public License as published by
25
24
#     GNU General Public License for more details.
26
25
27
26
# You should have received a copy of the GNU General Public License
28
 
# along with this program.  If not, see
29
 
# <http://www.gnu.org/licenses/>.
 
27
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
30
28
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
29
# Contact the authors at <https://www.fukt.bsnet.se/~belorn/> and
 
30
# <https://www.fukt.bsnet.se/~teddy/>.
32
31
33
32
 
34
 
from __future__ import division, with_statement, absolute_import
 
33
from __future__ import division
35
34
 
36
35
import SocketServer
37
36
import socket
38
 
import optparse
 
37
import select
 
38
from optparse import OptionParser
39
39
import datetime
40
40
import errno
41
41
import gnutls.crypto
55
55
import stat
56
56
import logging
57
57
import logging.handlers
58
 
import pwd
59
 
from contextlib import closing
60
58
 
61
59
import dbus
62
 
import dbus.service
63
60
import gobject
64
61
import avahi
65
62
from dbus.mainloop.glib import DBusGMainLoop
66
63
import ctypes
67
 
import ctypes.util
68
 
 
69
 
version = "1.0.5"
 
64
 
 
65
# Brief description of the operation of this program:
 
66
 
67
# This server announces itself as a Zeroconf service.  Connecting
 
68
# clients use the TLS protocol, with the unusual quirk that this
 
69
# server program acts as a TLS "client" while the connecting clients
 
70
# acts as a TLS "server".  The clients (acting as a TLS "server") must
 
71
# supply an OpenPGP certificate, and the fingerprint of this
 
72
# certificate is used by this server to look up (in a list read from a
 
73
# file at start time) which binary blob to give the client.  No other
 
74
# authentication or authorization is done by this server.
 
75
 
70
76
 
71
77
logger = logging.Logger('mandos')
72
 
syslogger = (logging.handlers.SysLogHandler
73
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
74
 
              address = "/dev/log"))
75
 
syslogger.setFormatter(logging.Formatter
76
 
                       ('Mandos [%(process)d]: %(levelname)s:'
77
 
                        ' %(message)s'))
 
78
syslogger = logging.handlers.SysLogHandler\
 
79
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
 
80
syslogger.setFormatter(logging.Formatter\
 
81
                        ('%(levelname)s: %(message)s'))
78
82
logger.addHandler(syslogger)
79
 
 
80
 
console = logging.StreamHandler()
81
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
82
 
                                       ' %(levelname)s: %(message)s'))
83
 
logger.addHandler(console)
84
 
 
85
 
class AvahiError(Exception):
86
 
    def __init__(self, value, *args, **kwargs):
87
 
        self.value = value
88
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
89
 
    def __unicode__(self):
90
 
        return unicode(repr(self.value))
91
 
 
92
 
class AvahiServiceError(AvahiError):
93
 
    pass
94
 
 
95
 
class AvahiGroupError(AvahiError):
96
 
    pass
97
 
 
98
 
 
99
 
class AvahiService(object):
100
 
    """An Avahi (Zeroconf) service.
101
 
    Attributes:
102
 
    interface: integer; avahi.IF_UNSPEC or an interface index.
103
 
               Used to optionally bind to the specified interface.
104
 
    name: string; Example: 'Mandos'
105
 
    type: string; Example: '_mandos._tcp'.
106
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
107
 
    port: integer; what port to announce
108
 
    TXT: list of strings; TXT record for the service
109
 
    domain: string; Domain to publish on, default to .local if empty.
110
 
    host: string; Host to publish records for, default is localhost
111
 
    max_renames: integer; maximum number of renames
112
 
    rename_count: integer; counter so we only rename after collisions
113
 
                  a sensible number of times
114
 
    """
115
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
116
 
                 servicetype = None, port = None, TXT = None,
117
 
                 domain = "", host = "", max_renames = 32768,
118
 
                 protocol = avahi.PROTO_UNSPEC):
119
 
        self.interface = interface
120
 
        self.name = name
121
 
        self.type = servicetype
122
 
        self.port = port
123
 
        self.TXT = TXT if TXT is not None else []
124
 
        self.domain = domain
125
 
        self.host = host
126
 
        self.rename_count = 0
127
 
        self.max_renames = max_renames
128
 
        self.protocol = protocol
129
 
    def rename(self):
130
 
        """Derived from the Avahi example code"""
131
 
        if self.rename_count >= self.max_renames:
132
 
            logger.critical(u"No suitable Zeroconf service name found"
133
 
                            u" after %i retries, exiting.",
134
 
                            self.rename_count)
135
 
            raise AvahiServiceError(u"Too many renames")
136
 
        self.name = server.GetAlternativeServiceName(self.name)
137
 
        logger.info(u"Changing Zeroconf service name to %r ...",
138
 
                    str(self.name))
139
 
        syslogger.setFormatter(logging.Formatter
140
 
                               ('Mandos (%s): %%(levelname)s:'
141
 
                                ' %%(message)s' % self.name))
142
 
        self.remove()
143
 
        self.add()
144
 
        self.rename_count += 1
145
 
    def remove(self):
146
 
        """Derived from the Avahi example code"""
147
 
        if group is not None:
148
 
            group.Reset()
149
 
    def add(self):
150
 
        """Derived from the Avahi example code"""
151
 
        global group
152
 
        if group is None:
153
 
            group = dbus.Interface(bus.get_object
154
 
                                   (avahi.DBUS_NAME,
155
 
                                    server.EntryGroupNew()),
156
 
                                   avahi.DBUS_INTERFACE_ENTRY_GROUP)
157
 
            group.connect_to_signal('StateChanged',
158
 
                                    entry_group_state_changed)
159
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
160
 
                     service.name, service.type)
161
 
        group.AddService(
162
 
                self.interface,         # interface
163
 
                self.protocol,          # protocol
164
 
                dbus.UInt32(0),         # flags
165
 
                self.name, self.type,
166
 
                self.domain, self.host,
167
 
                dbus.UInt16(self.port),
168
 
                avahi.string_array_to_txt_array(self.TXT))
169
 
        group.Commit()
170
 
 
 
83
del syslogger
 
84
 
 
85
# This variable is used to optionally bind to a specified interface.
 
86
# It is a global variable to fit in with the other variables from the
 
87
# Avahi example code.
 
88
serviceInterface = avahi.IF_UNSPEC
171
89
# From the Avahi example code:
172
 
group = None                            # our entry group
 
90
serviceName = "Mandos"
 
91
serviceType = "_mandos._tcp" # http://www.dns-sd.org/ServiceTypes.html
 
92
servicePort = None                      # Not known at startup
 
93
serviceTXT = []                         # TXT record for the service
 
94
domain = ""                  # Domain to publish on, default to .local
 
95
host = ""          # Host to publish records for, default to localhost
 
96
group = None #our entry group
 
97
rename_count = 12       # Counter so we only rename after collisions a
 
98
                        # sensible number of times
173
99
# End of Avahi example code
174
100
 
175
101
 
176
 
def _datetime_to_dbus(dt, variant_level=0):
177
 
    """Convert a UTC datetime.datetime() to a D-Bus type."""
178
 
    return dbus.String(dt.isoformat(), variant_level=variant_level)
179
 
 
180
 
 
181
 
class Client(dbus.service.Object):
 
102
class Client(object):
182
103
    """A representation of a client host served by this server.
183
104
    Attributes:
184
 
    name:       string; from the config file, used in log messages and
185
 
                        D-Bus identifiers
 
105
    name:      string; from the config file, used in log messages
186
106
    fingerprint: string (40 or 32 hexadecimal digits); used to
187
107
                 uniquely identify the client
188
 
    secret:     bytestring; sent verbatim (over TLS) to client
189
 
    host:       string; available for use by the checker command
190
 
    created:    datetime.datetime(); (UTC) object creation
191
 
    last_enabled: datetime.datetime(); (UTC)
192
 
    enabled:    bool()
193
 
    last_checked_ok: datetime.datetime(); (UTC) or None
194
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
195
 
                                      until this client is invalid
196
 
    interval:   datetime.timedelta(); How often to start a new checker
197
 
    disable_hook:  If set, called by disable() as disable_hook(self)
198
 
    checker:    subprocess.Popen(); a running checker process used
199
 
                                    to see if the client lives.
200
 
                                    'None' if no process is running.
 
108
    secret:    bytestring; sent verbatim (over TLS) to client
 
109
    fqdn:      string (FQDN); available for use by the checker command
 
110
    created:   datetime.datetime()
 
111
    last_seen: datetime.datetime() or None if not yet seen
 
112
    timeout:   datetime.timedelta(); How long from last_seen until
 
113
                                     this client is invalid
 
114
    interval:  datetime.timedelta(); How often to start a new checker
 
115
    stop_hook: If set, called by stop() as stop_hook(self)
 
116
    checker:   subprocess.Popen(); a running checker process used
 
117
                                   to see if the client lives.
 
118
                                   Is None if no process is running.
201
119
    checker_initiator_tag: a gobject event source tag, or None
202
 
    disable_initiator_tag:    - '' -
 
120
    stop_initiator_tag:    - '' -
203
121
    checker_callback_tag:  - '' -
204
122
    checker_command: string; External command which is run to check if
205
 
                     client lives.  %() expansions are done at
 
123
                     client lives.  %()s expansions are done at
206
124
                     runtime with vars(self) as dict, so that for
207
125
                     instance %(name)s can be used in the command.
208
 
    use_dbus: bool(); Whether to provide D-Bus interface and signals
209
 
    dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
 
126
    Private attibutes:
 
127
    _timeout: Real variable for 'timeout'
 
128
    _interval: Real variable for 'interval'
 
129
    _timeout_milliseconds: Used by gobject.timeout_add()
 
130
    _interval_milliseconds: - '' -
210
131
    """
211
 
    def timeout_milliseconds(self):
212
 
        "Return the 'timeout' attribute in milliseconds"
213
 
        return ((self.timeout.days * 24 * 60 * 60 * 1000)
214
 
                + (self.timeout.seconds * 1000)
215
 
                + (self.timeout.microseconds // 1000))
216
 
    
217
 
    def interval_milliseconds(self):
218
 
        "Return the 'interval' attribute in milliseconds"
219
 
        return ((self.interval.days * 24 * 60 * 60 * 1000)
220
 
                + (self.interval.seconds * 1000)
221
 
                + (self.interval.microseconds // 1000))
222
 
    
223
 
    def __init__(self, name = None, disable_hook=None, config=None,
224
 
                 use_dbus=True):
225
 
        """Note: the 'checker' key in 'config' sets the
226
 
        'checker_command' attribute and *not* the 'checker'
227
 
        attribute."""
 
132
    def _set_timeout(self, timeout):
 
133
        "Setter function for 'timeout' attribute"
 
134
        self._timeout = timeout
 
135
        self._timeout_milliseconds = ((self.timeout.days
 
136
                                       * 24 * 60 * 60 * 1000)
 
137
                                      + (self.timeout.seconds * 1000)
 
138
                                      + (self.timeout.microseconds
 
139
                                         // 1000))
 
140
    timeout = property(lambda self: self._timeout,
 
141
                       _set_timeout)
 
142
    del _set_timeout
 
143
    def _set_interval(self, interval):
 
144
        "Setter function for 'interval' attribute"
 
145
        self._interval = interval
 
146
        self._interval_milliseconds = ((self.interval.days
 
147
                                        * 24 * 60 * 60 * 1000)
 
148
                                       + (self.interval.seconds
 
149
                                          * 1000)
 
150
                                       + (self.interval.microseconds
 
151
                                          // 1000))
 
152
    interval = property(lambda self: self._interval,
 
153
                        _set_interval)
 
154
    del _set_interval
 
155
    def __init__(self, name=None, options=None, stop_hook=None,
 
156
                 fingerprint=None, secret=None, secfile=None,
 
157
                 fqdn=None, timeout=None, interval=-1, checker=None):
 
158
        """Note: the 'checker' argument sets the 'checker_command'
 
159
        attribute and not the 'checker' attribute.."""
228
160
        self.name = name
229
 
        if config is None:
230
 
            config = {}
231
 
        logger.debug(u"Creating client %r", self.name)
232
 
        self.use_dbus = False   # During __init__
233
 
        # Uppercase and remove spaces from fingerprint for later
234
 
        # comparison purposes with return value from the fingerprint()
235
 
        # function
236
 
        self.fingerprint = (config["fingerprint"].upper()
237
 
                            .replace(u" ", u""))
238
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
239
 
        if "secret" in config:
240
 
            self.secret = config["secret"].decode(u"base64")
241
 
        elif "secfile" in config:
242
 
            with closing(open(os.path.expanduser
243
 
                              (os.path.expandvars
244
 
                               (config["secfile"])))) as secfile:
245
 
                self.secret = secfile.read()
246
 
        else:
247
 
            raise TypeError(u"No secret or secfile for client %s"
248
 
                            % self.name)
249
 
        self.host = config.get("host", "")
250
 
        self.created = datetime.datetime.utcnow()
251
 
        self.enabled = False
252
 
        self.last_enabled = None
253
 
        self.last_checked_ok = None
254
 
        self.timeout = string_to_delta(config["timeout"])
255
 
        self.interval = string_to_delta(config["interval"])
256
 
        self.disable_hook = disable_hook
 
161
        # Uppercase and remove spaces from fingerprint
 
162
        # for later comparison purposes with return value of
 
163
        # the fingerprint() function
 
164
        self.fingerprint = fingerprint.upper().replace(u" ", u"")
 
165
        if secret:
 
166
            self.secret = secret.decode(u"base64")
 
167
        elif secfile:
 
168
            sf = open(secfile)
 
169
            self.secret = sf.read()
 
170
            sf.close()
 
171
        else:
 
172
            raise RuntimeError(u"No secret or secfile for client %s"
 
173
                               % self.name)
 
174
        self.fqdn = fqdn                # string
 
175
        self.created = datetime.datetime.now()
 
176
        self.last_seen = None
 
177
        if timeout is None:
 
178
            self.timeout = options.timeout
 
179
        else:
 
180
            self.timeout = string_to_delta(timeout)
 
181
        if interval == -1:
 
182
            self.interval = options.interval
 
183
        else:
 
184
            self.interval = string_to_delta(interval)
 
185
        self.stop_hook = stop_hook
257
186
        self.checker = None
258
187
        self.checker_initiator_tag = None
259
 
        self.disable_initiator_tag = None
 
188
        self.stop_initiator_tag = None
260
189
        self.checker_callback_tag = None
261
 
        self.checker_command = config["checker"]
262
 
        self.last_connect = None
263
 
        # Only now, when this client is initialized, can it show up on
264
 
        # the D-Bus
265
 
        self.use_dbus = use_dbus
266
 
        if self.use_dbus:
267
 
            self.dbus_object_path = (dbus.ObjectPath
268
 
                                     ("/clients/"
269
 
                                      + self.name.replace(".", "_")))
270
 
            dbus.service.Object.__init__(self, bus,
271
 
                                         self.dbus_object_path)
272
 
    
273
 
    def enable(self):
 
190
        self.check_command = checker
 
191
    def start(self):
274
192
        """Start this client's checker and timeout hooks"""
275
 
        self.last_enabled = datetime.datetime.utcnow()
276
193
        # Schedule a new checker to be started an 'interval' from now,
277
194
        # and every interval from then on.
278
 
        self.checker_initiator_tag = (gobject.timeout_add
279
 
                                      (self.interval_milliseconds(),
280
 
                                       self.start_checker))
 
195
        self.checker_initiator_tag = gobject.timeout_add\
 
196
                                     (self._interval_milliseconds,
 
197
                                      self.start_checker)
281
198
        # Also start a new checker *right now*.
282
199
        self.start_checker()
283
 
        # Schedule a disable() when 'timeout' has passed
284
 
        self.disable_initiator_tag = (gobject.timeout_add
285
 
                                   (self.timeout_milliseconds(),
286
 
                                    self.disable))
287
 
        self.enabled = True
288
 
        if self.use_dbus:
289
 
            # Emit D-Bus signals
290
 
            self.PropertyChanged(dbus.String(u"enabled"),
291
 
                                 dbus.Boolean(True, variant_level=1))
292
 
            self.PropertyChanged(dbus.String(u"last_enabled"),
293
 
                                 (_datetime_to_dbus(self.last_enabled,
294
 
                                                    variant_level=1)))
295
 
    
296
 
    def disable(self):
297
 
        """Disable this client."""
298
 
        if not getattr(self, "enabled", False):
 
200
        # Schedule a stop() when 'timeout' has passed
 
201
        self.stop_initiator_tag = gobject.timeout_add\
 
202
                                  (self._timeout_milliseconds,
 
203
                                   self.stop)
 
204
    def stop(self):
 
205
        """Stop this client.
 
206
        The possibility that this client might be restarted is left
 
207
        open, but not currently used."""
 
208
        # If this client doesn't have a secret, it is already stopped.
 
209
        if self.secret:
 
210
            logger.debug(u"Stopping client %s", self.name)
 
211
            self.secret = None
 
212
        else:
299
213
            return False
300
 
        logger.info(u"Disabling client %s", self.name)
301
 
        if getattr(self, "disable_initiator_tag", False):
302
 
            gobject.source_remove(self.disable_initiator_tag)
303
 
            self.disable_initiator_tag = None
304
 
        if getattr(self, "checker_initiator_tag", False):
 
214
        if hasattr(self, "stop_initiator_tag") \
 
215
               and self.stop_initiator_tag:
 
216
            gobject.source_remove(self.stop_initiator_tag)
 
217
            self.stop_initiator_tag = None
 
218
        if hasattr(self, "checker_initiator_tag") \
 
219
               and self.checker_initiator_tag:
305
220
            gobject.source_remove(self.checker_initiator_tag)
306
221
            self.checker_initiator_tag = None
307
222
        self.stop_checker()
308
 
        if self.disable_hook:
309
 
            self.disable_hook(self)
310
 
        self.enabled = False
311
 
        if self.use_dbus:
312
 
            # Emit D-Bus signal
313
 
            self.PropertyChanged(dbus.String(u"enabled"),
314
 
                                 dbus.Boolean(False, variant_level=1))
 
223
        if self.stop_hook:
 
224
            self.stop_hook(self)
315
225
        # Do not run this again if called by a gobject.timeout_add
316
226
        return False
317
 
    
318
227
    def __del__(self):
319
 
        self.disable_hook = None
320
 
        self.disable()
321
 
    
322
 
    def checker_callback(self, pid, condition, command):
 
228
        self.stop_hook = None
 
229
        self.stop()
 
230
    def checker_callback(self, pid, condition):
323
231
        """The checker has completed, so take appropriate actions."""
 
232
        now = datetime.datetime.now()
324
233
        self.checker_callback_tag = None
325
234
        self.checker = None
326
 
        if self.use_dbus:
327
 
            # Emit D-Bus signal
328
 
            self.PropertyChanged(dbus.String(u"checker_running"),
329
 
                                 dbus.Boolean(False, variant_level=1))
330
 
        if os.WIFEXITED(condition):
331
 
            exitstatus = os.WEXITSTATUS(condition)
332
 
            if exitstatus == 0:
333
 
                logger.info(u"Checker for %(name)s succeeded",
334
 
                            vars(self))
335
 
                self.checked_ok()
336
 
            else:
337
 
                logger.info(u"Checker for %(name)s failed",
338
 
                            vars(self))
339
 
            if self.use_dbus:
340
 
                # Emit D-Bus signal
341
 
                self.CheckerCompleted(dbus.Int16(exitstatus),
342
 
                                      dbus.Int64(condition),
343
 
                                      dbus.String(command))
344
 
        else:
 
235
        if os.WIFEXITED(condition) \
 
236
               and (os.WEXITSTATUS(condition) == 0):
 
237
            logger.debug(u"Checker for %(name)s succeeded",
 
238
                         vars(self))
 
239
            self.last_seen = now
 
240
            gobject.source_remove(self.stop_initiator_tag)
 
241
            self.stop_initiator_tag = gobject.timeout_add\
 
242
                                      (self._timeout_milliseconds,
 
243
                                       self.stop)
 
244
        elif not os.WIFEXITED(condition):
345
245
            logger.warning(u"Checker for %(name)s crashed?",
346
246
                           vars(self))
347
 
            if self.use_dbus:
348
 
                # Emit D-Bus signal
349
 
                self.CheckerCompleted(dbus.Int16(-1),
350
 
                                      dbus.Int64(condition),
351
 
                                      dbus.String(command))
352
 
    
353
 
    def checked_ok(self):
354
 
        """Bump up the timeout for this client.
355
 
        This should only be called when the client has been seen,
356
 
        alive and well.
357
 
        """
358
 
        self.last_checked_ok = datetime.datetime.utcnow()
359
 
        gobject.source_remove(self.disable_initiator_tag)
360
 
        self.disable_initiator_tag = (gobject.timeout_add
361
 
                                      (self.timeout_milliseconds(),
362
 
                                       self.disable))
363
 
        if self.use_dbus:
364
 
            # Emit D-Bus signal
365
 
            self.PropertyChanged(
366
 
                dbus.String(u"last_checked_ok"),
367
 
                (_datetime_to_dbus(self.last_checked_ok,
368
 
                                   variant_level=1)))
369
 
    
 
247
        else:
 
248
            logger.debug(u"Checker for %(name)s failed",
 
249
                         vars(self))
370
250
    def start_checker(self):
371
251
        """Start a new checker subprocess if one is not running.
372
252
        If a checker already exists, leave it running and do
381
261
        # is as it should be.
382
262
        if self.checker is None:
383
263
            try:
384
 
                # In case checker_command has exactly one % operator
385
 
                command = self.checker_command % self.host
 
264
                command = self.check_command % self.fqdn
386
265
            except TypeError:
387
 
                # Escape attributes for the shell
388
266
                escaped_attrs = dict((key, re.escape(str(val)))
389
267
                                     for key, val in
390
268
                                     vars(self).iteritems())
391
269
                try:
392
 
                    command = self.checker_command % escaped_attrs
 
270
                    command = self.check_command % escaped_attrs
393
271
                except TypeError, error:
394
 
                    logger.error(u'Could not format string "%s":'
395
 
                                 u' %s', self.checker_command, error)
 
272
                    logger.critical(u'Could not format string "%s":'
 
273
                                    u' %s', self.check_command, error)
396
274
                    return True # Try again later
397
275
            try:
398
 
                logger.info(u"Starting checker %r for %s",
399
 
                            command, self.name)
400
 
                # We don't need to redirect stdout and stderr, since
401
 
                # in normal mode, that is already done by daemon(),
402
 
                # and in debug mode we don't want to.  (Stdin is
403
 
                # always replaced by /dev/null.)
404
 
                self.checker = subprocess.Popen(command,
405
 
                                                close_fds=True,
406
 
                                                shell=True, cwd="/")
407
 
                if self.use_dbus:
408
 
                    # Emit D-Bus signal
409
 
                    self.CheckerStarted(command)
410
 
                    self.PropertyChanged(
411
 
                        dbus.String("checker_running"),
412
 
                        dbus.Boolean(True, variant_level=1))
413
 
                self.checker_callback_tag = (gobject.child_watch_add
414
 
                                             (self.checker.pid,
415
 
                                              self.checker_callback,
416
 
                                              data=command))
417
 
                # The checker may have completed before the gobject
418
 
                # watch was added.  Check for this.
419
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
420
 
                if pid:
421
 
                    gobject.source_remove(self.checker_callback_tag)
422
 
                    self.checker_callback(pid, status, command)
423
 
            except OSError, error:
 
276
                logger.debug(u"Starting checker %r for %s",
 
277
                             command, self.name)
 
278
                self.checker = subprocess.\
 
279
                               Popen(command,
 
280
                                     close_fds=True, shell=True,
 
281
                                     cwd="/")
 
282
                self.checker_callback_tag = gobject.child_watch_add\
 
283
                                            (self.checker.pid,
 
284
                                             self.checker_callback)
 
285
            except subprocess.OSError, error:
424
286
                logger.error(u"Failed to start subprocess: %s",
425
287
                             error)
426
288
        # Re-run this periodically if run by gobject.timeout_add
427
289
        return True
428
 
    
429
290
    def stop_checker(self):
430
291
        """Force the checker process, if any, to stop."""
431
292
        if self.checker_callback_tag:
432
293
            gobject.source_remove(self.checker_callback_tag)
433
294
            self.checker_callback_tag = None
434
 
        if getattr(self, "checker", None) is None:
 
295
        if not hasattr(self, "checker") or self.checker is None:
435
296
            return
436
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
297
        logger.debug("Stopping checker for %(name)s", vars(self))
437
298
        try:
438
299
            os.kill(self.checker.pid, signal.SIGTERM)
439
300
            #os.sleep(0.5)
440
301
            #if self.checker.poll() is None:
441
302
            #    os.kill(self.checker.pid, signal.SIGKILL)
442
303
        except OSError, error:
443
 
            if error.errno != errno.ESRCH: # No such process
 
304
            if error.errno != errno.ESRCH:
444
305
                raise
445
306
        self.checker = None
446
 
        if self.use_dbus:
447
 
            self.PropertyChanged(dbus.String(u"checker_running"),
448
 
                                 dbus.Boolean(False, variant_level=1))
449
 
    
450
 
    def still_valid(self):
 
307
    def still_valid(self, now=None):
451
308
        """Has the timeout not yet passed for this client?"""
452
 
        if not getattr(self, "enabled", False):
453
 
            return False
454
 
        now = datetime.datetime.utcnow()
455
 
        if self.last_checked_ok is None:
 
309
        if now is None:
 
310
            now = datetime.datetime.now()
 
311
        if self.last_seen is None:
456
312
            return now < (self.created + self.timeout)
457
313
        else:
458
 
            return now < (self.last_checked_ok + self.timeout)
459
 
    
460
 
    ## D-Bus methods & signals
461
 
    _interface = u"se.bsnet.fukt.Mandos.Client"
462
 
    
463
 
    # CheckedOK - method
464
 
    CheckedOK = dbus.service.method(_interface)(checked_ok)
465
 
    CheckedOK.__name__ = "CheckedOK"
466
 
    
467
 
    # CheckerCompleted - signal
468
 
    @dbus.service.signal(_interface, signature="nxs")
469
 
    def CheckerCompleted(self, exitcode, waitstatus, command):
470
 
        "D-Bus signal"
471
 
        pass
472
 
    
473
 
    # CheckerStarted - signal
474
 
    @dbus.service.signal(_interface, signature="s")
475
 
    def CheckerStarted(self, command):
476
 
        "D-Bus signal"
477
 
        pass
478
 
    
479
 
    # GetAllProperties - method
480
 
    @dbus.service.method(_interface, out_signature="a{sv}")
481
 
    def GetAllProperties(self):
482
 
        "D-Bus method"
483
 
        return dbus.Dictionary({
484
 
                dbus.String("name"):
485
 
                    dbus.String(self.name, variant_level=1),
486
 
                dbus.String("fingerprint"):
487
 
                    dbus.String(self.fingerprint, variant_level=1),
488
 
                dbus.String("host"):
489
 
                    dbus.String(self.host, variant_level=1),
490
 
                dbus.String("created"):
491
 
                    _datetime_to_dbus(self.created, variant_level=1),
492
 
                dbus.String("last_enabled"):
493
 
                    (_datetime_to_dbus(self.last_enabled,
494
 
                                       variant_level=1)
495
 
                     if self.last_enabled is not None
496
 
                     else dbus.Boolean(False, variant_level=1)),
497
 
                dbus.String("enabled"):
498
 
                    dbus.Boolean(self.enabled, variant_level=1),
499
 
                dbus.String("last_checked_ok"):
500
 
                    (_datetime_to_dbus(self.last_checked_ok,
501
 
                                       variant_level=1)
502
 
                     if self.last_checked_ok is not None
503
 
                     else dbus.Boolean (False, variant_level=1)),
504
 
                dbus.String("timeout"):
505
 
                    dbus.UInt64(self.timeout_milliseconds(),
506
 
                                variant_level=1),
507
 
                dbus.String("interval"):
508
 
                    dbus.UInt64(self.interval_milliseconds(),
509
 
                                variant_level=1),
510
 
                dbus.String("checker"):
511
 
                    dbus.String(self.checker_command,
512
 
                                variant_level=1),
513
 
                dbus.String("checker_running"):
514
 
                    dbus.Boolean(self.checker is not None,
515
 
                                 variant_level=1),
516
 
                dbus.String("object_path"):
517
 
                    dbus.ObjectPath(self.dbus_object_path,
518
 
                                    variant_level=1)
519
 
                }, signature="sv")
520
 
    
521
 
    # IsStillValid - method
522
 
    IsStillValid = (dbus.service.method(_interface, out_signature="b")
523
 
                    (still_valid))
524
 
    IsStillValid.__name__ = "IsStillValid"
525
 
    
526
 
    # PropertyChanged - signal
527
 
    @dbus.service.signal(_interface, signature="sv")
528
 
    def PropertyChanged(self, property, value):
529
 
        "D-Bus signal"
530
 
        pass
531
 
    
532
 
    # SetChecker - method
533
 
    @dbus.service.method(_interface, in_signature="s")
534
 
    def SetChecker(self, checker):
535
 
        "D-Bus setter method"
536
 
        self.checker_command = checker
537
 
        # Emit D-Bus signal
538
 
        self.PropertyChanged(dbus.String(u"checker"),
539
 
                             dbus.String(self.checker_command,
540
 
                                         variant_level=1))
541
 
    
542
 
    # SetHost - method
543
 
    @dbus.service.method(_interface, in_signature="s")
544
 
    def SetHost(self, host):
545
 
        "D-Bus setter method"
546
 
        self.host = host
547
 
        # Emit D-Bus signal
548
 
        self.PropertyChanged(dbus.String(u"host"),
549
 
                             dbus.String(self.host, variant_level=1))
550
 
    
551
 
    # SetInterval - method
552
 
    @dbus.service.method(_interface, in_signature="t")
553
 
    def SetInterval(self, milliseconds):
554
 
        self.interval = datetime.timedelta(0, 0, 0, milliseconds)
555
 
        # Emit D-Bus signal
556
 
        self.PropertyChanged(dbus.String(u"interval"),
557
 
                             (dbus.UInt64(self.interval_milliseconds(),
558
 
                                          variant_level=1)))
559
 
    
560
 
    # SetSecret - method
561
 
    @dbus.service.method(_interface, in_signature="ay",
562
 
                         byte_arrays=True)
563
 
    def SetSecret(self, secret):
564
 
        "D-Bus setter method"
565
 
        self.secret = str(secret)
566
 
    
567
 
    # SetTimeout - method
568
 
    @dbus.service.method(_interface, in_signature="t")
569
 
    def SetTimeout(self, milliseconds):
570
 
        self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
571
 
        # Emit D-Bus signal
572
 
        self.PropertyChanged(dbus.String(u"timeout"),
573
 
                             (dbus.UInt64(self.timeout_milliseconds(),
574
 
                                          variant_level=1)))
575
 
    
576
 
    # Enable - method
577
 
    Enable = dbus.service.method(_interface)(enable)
578
 
    Enable.__name__ = "Enable"
579
 
    
580
 
    # StartChecker - method
581
 
    @dbus.service.method(_interface)
582
 
    def StartChecker(self):
583
 
        "D-Bus method"
584
 
        self.start_checker()
585
 
    
586
 
    # Disable - method
587
 
    @dbus.service.method(_interface)
588
 
    def Disable(self):
589
 
        "D-Bus method"
590
 
        self.disable()
591
 
    
592
 
    # StopChecker - method
593
 
    StopChecker = dbus.service.method(_interface)(stop_checker)
594
 
    StopChecker.__name__ = "StopChecker"
595
 
    
596
 
    del _interface
 
314
            return now < (self.last_seen + self.timeout)
597
315
 
598
316
 
599
317
def peer_certificate(session):
600
318
    "Return the peer's OpenPGP certificate as a bytestring"
601
319
    # If not an OpenPGP certificate...
602
 
    if (gnutls.library.functions
603
 
        .gnutls_certificate_type_get(session._c_object)
604
 
        != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
320
    if gnutls.library.functions.gnutls_certificate_type_get\
 
321
            (session._c_object) \
 
322
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
605
323
        # ...do the normal thing
606
324
        return session.peer_certificate
607
 
    list_size = ctypes.c_uint(1)
608
 
    cert_list = (gnutls.library.functions
609
 
                 .gnutls_certificate_get_peers
610
 
                 (session._c_object, ctypes.byref(list_size)))
611
 
    if not bool(cert_list) and list_size.value != 0:
612
 
        raise gnutls.errors.GNUTLSError("error getting peer"
613
 
                                        " certificate")
 
325
    list_size = ctypes.c_uint()
 
326
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
327
        (session._c_object, ctypes.byref(list_size))
614
328
    if list_size.value == 0:
615
329
        return None
616
330
    cert = cert_list[0]
619
333
 
620
334
def fingerprint(openpgp):
621
335
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
622
 
    # New GnuTLS "datum" with the OpenPGP public key
623
 
    datum = (gnutls.library.types
624
 
             .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
625
 
                                         ctypes.POINTER
626
 
                                         (ctypes.c_ubyte)),
627
 
                             ctypes.c_uint(len(openpgp))))
628
336
    # New empty GnuTLS certificate
629
337
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
630
 
    (gnutls.library.functions
631
 
     .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
338
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
339
        (ctypes.byref(crt))
 
340
    # New GnuTLS "datum" with the OpenPGP public key
 
341
    datum = gnutls.library.types.gnutls_datum_t\
 
342
        (ctypes.cast(ctypes.c_char_p(openpgp),
 
343
                     ctypes.POINTER(ctypes.c_ubyte)),
 
344
         ctypes.c_uint(len(openpgp)))
632
345
    # Import the OpenPGP public key into the certificate
633
 
    (gnutls.library.functions
634
 
     .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
635
 
                                gnutls.library.constants
636
 
                                .GNUTLS_OPENPGP_FMT_RAW))
637
 
    # Verify the self signature in the key
638
 
    crtverify = ctypes.c_uint()
639
 
    (gnutls.library.functions
640
 
     .gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
641
 
    if crtverify.value != 0:
642
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
643
 
        raise gnutls.errors.CertificateSecurityError("Verify failed")
 
346
    ret = gnutls.library.functions.gnutls_openpgp_crt_import\
 
347
        (crt,
 
348
         ctypes.byref(datum),
 
349
         gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
644
350
    # New buffer for the fingerprint
645
 
    buf = ctypes.create_string_buffer(20)
646
 
    buf_len = ctypes.c_size_t()
 
351
    buffer = ctypes.create_string_buffer(20)
 
352
    buffer_length = ctypes.c_size_t()
647
353
    # Get the fingerprint from the certificate into the buffer
648
 
    (gnutls.library.functions
649
 
     .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
650
 
                                         ctypes.byref(buf_len)))
 
354
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
355
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
651
356
    # Deinit the certificate
652
357
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
653
358
    # Convert the buffer to a Python bytestring
654
 
    fpr = ctypes.string_at(buf, buf_len.value)
 
359
    fpr = ctypes.string_at(buffer, buffer_length.value)
655
360
    # Convert the bytestring to hexadecimal notation
656
361
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
657
362
    return hex_fpr
658
363
 
659
364
 
660
 
class TCP_handler(SocketServer.BaseRequestHandler, object):
 
365
class tcp_handler(SocketServer.BaseRequestHandler, object):
661
366
    """A TCP request handler class.
662
367
    Instantiated by IPv6_TCPServer for each request to handle it.
663
368
    Note: This will run in its own forked process."""
664
369
    
665
370
    def handle(self):
666
 
        logger.info(u"TCP connection from: %s",
667
 
                    unicode(self.client_address))
668
 
        session = (gnutls.connection
669
 
                   .ClientSession(self.request,
670
 
                                  gnutls.connection
671
 
                                  .X509Credentials()))
672
 
        
673
 
        line = self.request.makefile().readline()
674
 
        logger.debug(u"Protocol version: %r", line)
675
 
        try:
676
 
            if int(line.strip().split()[0]) > 1:
677
 
                raise RuntimeError
678
 
        except (ValueError, IndexError, RuntimeError), error:
679
 
            logger.error(u"Unknown protocol version: %s", error)
680
 
            return
681
 
        
682
 
        # Note: gnutls.connection.X509Credentials is really a generic
683
 
        # GnuTLS certificate credentials object so long as no X.509
684
 
        # keys are added to it.  Therefore, we can use it here despite
685
 
        # using OpenPGP certificates.
 
371
        logger.debug(u"TCP connection from: %s",
 
372
                     unicode(self.client_address))
 
373
        session = gnutls.connection.ClientSession(self.request,
 
374
                                                  gnutls.connection.\
 
375
                                                  X509Credentials())
686
376
        
687
377
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
688
 
        #                     "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
689
 
        #                     "+DHE-DSS"))
690
 
        # Use a fallback default, since this MUST be set.
691
 
        priority = self.server.settings.get("priority", "NORMAL")
692
 
        (gnutls.library.functions
693
 
         .gnutls_priority_set_direct(session._c_object,
694
 
                                     priority, None))
 
378
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
379
        #                "+DHE-DSS"))
 
380
        priority = "SECURE256"
 
381
        
 
382
        gnutls.library.functions.gnutls_priority_set_direct\
 
383
            (session._c_object, priority, None);
695
384
        
696
385
        try:
697
386
            session.handshake()
698
387
        except gnutls.errors.GNUTLSError, error:
699
 
            logger.warning(u"Handshake failed: %s", error)
 
388
            logger.debug(u"Handshake failed: %s", error)
700
389
            # Do not run session.bye() here: the session is not
701
390
            # established.  Just abandon the request.
702
391
            return
703
 
        logger.debug(u"Handshake succeeded")
704
392
        try:
705
393
            fpr = fingerprint(peer_certificate(session))
706
394
        except (TypeError, gnutls.errors.GNUTLSError), error:
707
 
            logger.warning(u"Bad certificate: %s", error)
 
395
            logger.debug(u"Bad certificate: %s", error)
708
396
            session.bye()
709
397
            return
710
398
        logger.debug(u"Fingerprint: %s", fpr)
711
 
        
 
399
        client = None
712
400
        for c in self.server.clients:
713
401
            if c.fingerprint == fpr:
714
402
                client = c
715
403
                break
716
 
        else:
717
 
            logger.warning(u"Client not found for fingerprint: %s",
718
 
                           fpr)
719
 
            session.bye()
720
 
            return
721
404
        # Have to check if client.still_valid(), since it is possible
722
405
        # that the client timed out while establishing the GnuTLS
723
406
        # session.
724
 
        if not client.still_valid():
725
 
            logger.warning(u"Client %(name)s is invalid",
726
 
                           vars(client))
 
407
        if (not client) or (not client.still_valid()):
 
408
            if client:
 
409
                logger.debug(u"Client %(name)s is invalid",
 
410
                             vars(client))
 
411
            else:
 
412
                logger.debug(u"Client not found for fingerprint: %s",
 
413
                             fpr)
727
414
            session.bye()
728
415
            return
729
 
        ## This won't work here, since we're in a fork.
730
 
        # client.checked_ok()
731
416
        sent_size = 0
732
417
        while sent_size < len(client.secret):
733
418
            sent = session.send(client.secret[sent_size:])
738
423
        session.bye()
739
424
 
740
425
 
741
 
class IPv6_TCPServer(SocketServer.ForkingMixIn,
742
 
                     SocketServer.TCPServer, object):
743
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port.
 
426
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
427
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
744
428
    Attributes:
745
 
        settings:       Server settings
 
429
        options:        Command line options
746
430
        clients:        Set() of Client objects
747
 
        enabled:        Boolean; whether this server is activated yet
748
431
    """
749
432
    address_family = socket.AF_INET6
750
433
    def __init__(self, *args, **kwargs):
751
 
        if "settings" in kwargs:
752
 
            self.settings = kwargs["settings"]
753
 
            del kwargs["settings"]
 
434
        if "options" in kwargs:
 
435
            self.options = kwargs["options"]
 
436
            del kwargs["options"]
754
437
        if "clients" in kwargs:
755
438
            self.clients = kwargs["clients"]
756
439
            del kwargs["clients"]
757
 
        if "use_ipv6" in kwargs:
758
 
            if not kwargs["use_ipv6"]:
759
 
                self.address_family = socket.AF_INET
760
 
            del kwargs["use_ipv6"]
761
 
        self.enabled = False
762
 
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
 
440
        return super(type(self), self).__init__(*args, **kwargs)
763
441
    def server_bind(self):
764
442
        """This overrides the normal server_bind() function
765
443
        to bind to an interface if one was specified, and also NOT to
766
444
        bind to an address or port if they were not specified."""
767
 
        if self.settings["interface"]:
768
 
            # 25 is from /usr/include/asm-i486/socket.h
769
 
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
445
        if self.options.interface:
 
446
            if not hasattr(socket, "SO_BINDTODEVICE"):
 
447
                # From /usr/include/asm-i486/socket.h
 
448
                socket.SO_BINDTODEVICE = 25
770
449
            try:
771
450
                self.socket.setsockopt(socket.SOL_SOCKET,
772
 
                                       SO_BINDTODEVICE,
773
 
                                       self.settings["interface"])
 
451
                                       socket.SO_BINDTODEVICE,
 
452
                                       self.options.interface)
774
453
            except socket.error, error:
775
454
                if error[0] == errno.EPERM:
776
 
                    logger.error(u"No permission to"
777
 
                                 u" bind to interface %s",
778
 
                                 self.settings["interface"])
 
455
                    logger.warning(u"No permission to"
 
456
                                   u" bind to interface %s",
 
457
                                   self.options.interface)
779
458
                else:
780
 
                    raise
 
459
                    raise error
781
460
        # Only bind(2) the socket if we really need to.
782
461
        if self.server_address[0] or self.server_address[1]:
783
462
            if not self.server_address[0]:
784
 
                if self.address_family == socket.AF_INET6:
785
 
                    any_address = "::" # in6addr_any
786
 
                else:
787
 
                    any_address = socket.INADDR_ANY
788
 
                self.server_address = (any_address,
 
463
                in6addr_any = "::"
 
464
                self.server_address = (in6addr_any,
789
465
                                       self.server_address[1])
790
 
            elif not self.server_address[1]:
 
466
            elif self.server_address[1] is None:
791
467
                self.server_address = (self.server_address[0],
792
468
                                       0)
793
 
#                 if self.settings["interface"]:
794
 
#                     self.server_address = (self.server_address[0],
795
 
#                                            0, # port
796
 
#                                            0, # flowinfo
797
 
#                                            if_nametoindex
798
 
#                                            (self.settings
799
 
#                                             ["interface"]))
800
 
            return super(IPv6_TCPServer, self).server_bind()
801
 
    def server_activate(self):
802
 
        if self.enabled:
803
 
            return super(IPv6_TCPServer, self).server_activate()
804
 
    def enable(self):
805
 
        self.enabled = True
 
469
            return super(type(self), self).server_bind()
806
470
 
807
471
 
808
472
def string_to_delta(interval):
809
473
    """Parse a string and return a datetime.timedelta
810
 
    
 
474
 
811
475
    >>> string_to_delta('7d')
812
476
    datetime.timedelta(7)
813
477
    >>> string_to_delta('60s')
818
482
    datetime.timedelta(1)
819
483
    >>> string_to_delta(u'1w')
820
484
    datetime.timedelta(7)
821
 
    >>> string_to_delta('5m 30s')
822
 
    datetime.timedelta(0, 330)
823
485
    """
824
 
    timevalue = datetime.timedelta(0)
825
 
    for s in interval.split():
826
 
        try:
827
 
            suffix = unicode(s[-1])
828
 
            value = int(s[:-1])
829
 
            if suffix == u"d":
830
 
                delta = datetime.timedelta(value)
831
 
            elif suffix == u"s":
832
 
                delta = datetime.timedelta(0, value)
833
 
            elif suffix == u"m":
834
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
835
 
            elif suffix == u"h":
836
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
837
 
            elif suffix == u"w":
838
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
839
 
            else:
840
 
                raise ValueError
841
 
        except (ValueError, IndexError):
 
486
    try:
 
487
        suffix=unicode(interval[-1])
 
488
        value=int(interval[:-1])
 
489
        if suffix == u"d":
 
490
            delta = datetime.timedelta(value)
 
491
        elif suffix == u"s":
 
492
            delta = datetime.timedelta(0, value)
 
493
        elif suffix == u"m":
 
494
            delta = datetime.timedelta(0, 0, 0, 0, value)
 
495
        elif suffix == u"h":
 
496
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
497
        elif suffix == u"w":
 
498
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
499
        else:
842
500
            raise ValueError
843
 
        timevalue += delta
844
 
    return timevalue
 
501
    except (ValueError, IndexError):
 
502
        raise ValueError
 
503
    return delta
 
504
 
 
505
 
 
506
def add_service():
 
507
    """Derived from the Avahi example code"""
 
508
    global group, serviceName, serviceType, servicePort, serviceTXT, \
 
509
           domain, host
 
510
    if group is None:
 
511
        group = dbus.Interface(
 
512
                bus.get_object( avahi.DBUS_NAME,
 
513
                                server.EntryGroupNew()),
 
514
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
515
        group.connect_to_signal('StateChanged',
 
516
                                entry_group_state_changed)
 
517
    logger.debug(u"Adding service '%s' of type '%s' ...",
 
518
                 serviceName, serviceType)
 
519
    
 
520
    group.AddService(
 
521
            serviceInterface,           # interface
 
522
            avahi.PROTO_INET6,          # protocol
 
523
            dbus.UInt32(0),             # flags
 
524
            serviceName, serviceType,
 
525
            domain, host,
 
526
            dbus.UInt16(servicePort),
 
527
            avahi.string_array_to_txt_array(serviceTXT))
 
528
    group.Commit()
 
529
 
 
530
 
 
531
def remove_service():
 
532
    """From the Avahi example code"""
 
533
    global group
 
534
    
 
535
    if not group is None:
 
536
        group.Reset()
845
537
 
846
538
 
847
539
def server_state_changed(state):
848
540
    """Derived from the Avahi example code"""
849
541
    if state == avahi.SERVER_COLLISION:
850
 
        logger.error(u"Zeroconf server name collision")
851
 
        service.remove()
 
542
        logger.warning(u"Server name collision")
 
543
        remove_service()
852
544
    elif state == avahi.SERVER_RUNNING:
853
 
        service.add()
 
545
        add_service()
854
546
 
855
547
 
856
548
def entry_group_state_changed(state, error):
857
549
    """Derived from the Avahi example code"""
858
 
    logger.debug(u"Avahi state change: %i", state)
 
550
    global serviceName, server, rename_count
 
551
    
 
552
    logger.debug(u"state change: %i", state)
859
553
    
860
554
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
861
 
        logger.debug(u"Zeroconf service established.")
 
555
        logger.debug(u"Service established.")
862
556
    elif state == avahi.ENTRY_GROUP_COLLISION:
863
 
        logger.warning(u"Zeroconf service name collision.")
864
 
        service.rename()
 
557
        
 
558
        rename_count = rename_count - 1
 
559
        if rename_count > 0:
 
560
            name = server.GetAlternativeServiceName(name)
 
561
            logger.warning(u"Service name collision, "
 
562
                           u"changing name to '%s' ...", name)
 
563
            remove_service()
 
564
            add_service()
 
565
            
 
566
        else:
 
567
            logger.error(u"No suitable service name found after %i"
 
568
                         u" retries, exiting.", n_rename)
 
569
            killme(1)
865
570
    elif state == avahi.ENTRY_GROUP_FAILURE:
866
 
        logger.critical(u"Avahi: Error in group state changed %s",
867
 
                        unicode(error))
868
 
        raise AvahiGroupError(u"State changed: %s" % unicode(error))
 
571
        logger.error(u"Error in group state changed %s",
 
572
                     unicode(error))
 
573
        killme(1)
 
574
 
869
575
 
870
576
def if_nametoindex(interface):
871
 
    """Call the C function if_nametoindex(), or equivalent"""
872
 
    global if_nametoindex
 
577
    """Call the C function if_nametoindex()"""
873
578
    try:
874
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
875
 
                          (ctypes.util.find_library("c"))
876
 
                          .if_nametoindex)
 
579
        libc = ctypes.cdll.LoadLibrary("libc.so.6")
 
580
        return libc.if_nametoindex(interface)
877
581
    except (OSError, AttributeError):
878
582
        if "struct" not in sys.modules:
879
583
            import struct
880
584
        if "fcntl" not in sys.modules:
881
585
            import fcntl
882
 
        def if_nametoindex(interface):
883
 
            "Get an interface index the hard way, i.e. using fcntl()"
884
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
885
 
            with closing(socket.socket()) as s:
886
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
887
 
                                    struct.pack("16s16x", interface))
888
 
            interface_index = struct.unpack("I", ifreq[16:20])[0]
889
 
            return interface_index
890
 
    return if_nametoindex(interface)
891
 
 
892
 
 
893
 
def daemon(nochdir = False, noclose = False):
 
586
        SIOCGIFINDEX = 0x8933      # From /usr/include/linux/sockios.h
 
587
        s = socket.socket()
 
588
        ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
589
                            struct.pack("16s16x", interface))
 
590
        s.close()
 
591
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
592
        return interface_index
 
593
 
 
594
 
 
595
def daemon(nochdir, noclose):
894
596
    """See daemon(3).  Standard BSD Unix function.
895
597
    This should really exist as os.daemon, but it doesn't (yet)."""
896
598
    if os.fork():
898
600
    os.setsid()
899
601
    if not nochdir:
900
602
        os.chdir("/")
901
 
    if os.fork():
902
 
        sys.exit()
903
603
    if not noclose:
904
604
        # Close all standard open file descriptors
905
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
605
        null = os.open("/dev/null", os.O_NOCTTY | os.O_RDWR)
906
606
        if not stat.S_ISCHR(os.fstat(null).st_mode):
907
607
            raise OSError(errno.ENODEV,
908
608
                          "/dev/null not a character device")
913
613
            os.close(null)
914
614
 
915
615
 
 
616
def killme(status = 0):
 
617
    logger.debug("Stopping server with exit status %d", status)
 
618
    exitstatus = status
 
619
    if main_loop_started:
 
620
        main_loop.quit()
 
621
    else:
 
622
        sys.exit(status)
 
623
 
 
624
 
916
625
def main():
917
 
    parser = optparse.OptionParser(version = "%%prog %s" % version)
 
626
    global exitstatus
 
627
    exitstatus = 0
 
628
    global main_loop_started
 
629
    main_loop_started = False
 
630
    
 
631
    parser = OptionParser()
918
632
    parser.add_option("-i", "--interface", type="string",
919
 
                      metavar="IF", help="Bind to interface IF")
920
 
    parser.add_option("-a", "--address", type="string",
 
633
                      default=None, metavar="IF",
 
634
                      help="Bind to interface IF")
 
635
    parser.add_option("-a", "--address", type="string", default=None,
921
636
                      help="Address to listen for requests on")
922
 
    parser.add_option("-p", "--port", type="int",
 
637
    parser.add_option("-p", "--port", type="int", default=None,
923
638
                      help="Port number to receive requests on")
924
 
    parser.add_option("--check", action="store_true",
 
639
    parser.add_option("--timeout", type="string", # Parsed later
 
640
                      default="1h",
 
641
                      help="Amount of downtime allowed for clients")
 
642
    parser.add_option("--interval", type="string", # Parsed later
 
643
                      default="5m",
 
644
                      help="How often to check that a client is up")
 
645
    parser.add_option("--check", action="store_true", default=False,
925
646
                      help="Run self-test")
926
 
    parser.add_option("--debug", action="store_true",
927
 
                      help="Debug mode; run in foreground and log to"
928
 
                      " terminal")
929
 
    parser.add_option("--priority", type="string", help="GnuTLS"
930
 
                      " priority string (see GnuTLS documentation)")
931
 
    parser.add_option("--servicename", type="string", metavar="NAME",
932
 
                      help="Zeroconf service name")
933
 
    parser.add_option("--configdir", type="string",
934
 
                      default="/etc/mandos", metavar="DIR",
935
 
                      help="Directory to search for configuration"
936
 
                      " files")
937
 
    parser.add_option("--no-dbus", action="store_false",
938
 
                      dest="use_dbus",
939
 
                      help="Do not provide D-Bus system bus"
940
 
                      " interface")
941
 
    parser.add_option("--no-ipv6", action="store_false",
942
 
                      dest="use_ipv6", help="Do not use IPv6")
943
 
    options = parser.parse_args()[0]
 
647
    parser.add_option("--debug", action="store_true", default=False,
 
648
                      help="Debug mode")
 
649
    (options, args) = parser.parse_args()
944
650
    
945
651
    if options.check:
946
652
        import doctest
947
653
        doctest.testmod()
948
654
        sys.exit()
949
655
    
950
 
    # Default values for config file for server-global settings
951
 
    server_defaults = { "interface": "",
952
 
                        "address": "",
953
 
                        "port": "",
954
 
                        "debug": "False",
955
 
                        "priority":
956
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
957
 
                        "servicename": "Mandos",
958
 
                        "use_dbus": "True",
959
 
                        "use_ipv6": "True",
960
 
                        }
961
 
    
962
 
    # Parse config file for server-global settings
963
 
    server_config = ConfigParser.SafeConfigParser(server_defaults)
964
 
    del server_defaults
965
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
966
 
    # Convert the SafeConfigParser object to a dict
967
 
    server_settings = server_config.defaults()
968
 
    # Use the appropriate methods on the non-string config options
969
 
    server_settings["debug"] = server_config.getboolean("DEFAULT",
970
 
                                                        "debug")
971
 
    server_settings["use_dbus"] = server_config.getboolean("DEFAULT",
972
 
                                                           "use_dbus")
973
 
    server_settings["use_ipv6"] = server_config.getboolean("DEFAULT",
974
 
                                                           "use_ipv6")
975
 
    if server_settings["port"]:
976
 
        server_settings["port"] = server_config.getint("DEFAULT",
977
 
                                                       "port")
978
 
    del server_config
979
 
    
980
 
    # Override the settings from the config file with command line
981
 
    # options, if set.
982
 
    for option in ("interface", "address", "port", "debug",
983
 
                   "priority", "servicename", "configdir",
984
 
                   "use_dbus", "use_ipv6"):
985
 
        value = getattr(options, option)
986
 
        if value is not None:
987
 
            server_settings[option] = value
988
 
    del options
989
 
    # Now we have our good server settings in "server_settings"
990
 
    
991
 
    # For convenience
992
 
    debug = server_settings["debug"]
993
 
    use_dbus = server_settings["use_dbus"]
994
 
    use_ipv6 = server_settings["use_ipv6"]
995
 
    
996
 
    if not debug:
997
 
        syslogger.setLevel(logging.WARNING)
998
 
        console.setLevel(logging.WARNING)
999
 
    
1000
 
    if server_settings["servicename"] != "Mandos":
1001
 
        syslogger.setFormatter(logging.Formatter
1002
 
                               ('Mandos (%s): %%(levelname)s:'
1003
 
                                ' %%(message)s'
1004
 
                                % server_settings["servicename"]))
1005
 
    
1006
 
    # Parse config file with clients
1007
 
    client_defaults = { "timeout": "1h",
1008
 
                        "interval": "5m",
1009
 
                        "checker": "fping -q -- %%(host)s",
1010
 
                        "host": "",
1011
 
                        }
1012
 
    client_config = ConfigParser.SafeConfigParser(client_defaults)
1013
 
    client_config.read(os.path.join(server_settings["configdir"],
1014
 
                                    "clients.conf"))
1015
 
    
1016
 
    clients = Set()
1017
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
1018
 
                                 server_settings["port"]),
1019
 
                                TCP_handler,
1020
 
                                settings=server_settings,
1021
 
                                clients=clients, use_ipv6=use_ipv6)
1022
 
    pidfilename = "/var/run/mandos.pid"
1023
 
    try:
1024
 
        pidfile = open(pidfilename, "w")
1025
 
    except IOError:
1026
 
        logger.error("Could not open file %r", pidfilename)
1027
 
    
1028
 
    try:
1029
 
        uid = pwd.getpwnam("_mandos").pw_uid
1030
 
        gid = pwd.getpwnam("_mandos").pw_gid
1031
 
    except KeyError:
1032
 
        try:
1033
 
            uid = pwd.getpwnam("mandos").pw_uid
1034
 
            gid = pwd.getpwnam("mandos").pw_gid
1035
 
        except KeyError:
1036
 
            try:
1037
 
                uid = pwd.getpwnam("nobody").pw_uid
1038
 
                gid = pwd.getpwnam("nogroup").pw_gid
1039
 
            except KeyError:
1040
 
                uid = 65534
1041
 
                gid = 65534
1042
 
    try:
1043
 
        os.setgid(gid)
1044
 
        os.setuid(uid)
1045
 
    except OSError, error:
1046
 
        if error[0] != errno.EPERM:
1047
 
            raise error
1048
 
    
1049
 
    # Enable all possible GnuTLS debugging
1050
 
    if debug:
1051
 
        # "Use a log level over 10 to enable all debugging options."
1052
 
        # - GnuTLS manual
1053
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
1054
 
        
1055
 
        @gnutls.library.types.gnutls_log_func
1056
 
        def debug_gnutls(level, string):
1057
 
            logger.debug("GnuTLS: %s", string[:-1])
1058
 
        
1059
 
        (gnutls.library.functions
1060
 
         .gnutls_global_set_log_function(debug_gnutls))
1061
 
    
1062
 
    global service
1063
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1064
 
    service = AvahiService(name = server_settings["servicename"],
1065
 
                           servicetype = "_mandos._tcp",
1066
 
                           protocol = protocol)
1067
 
    if server_settings["interface"]:
1068
 
        service.interface = (if_nametoindex
1069
 
                             (server_settings["interface"]))
 
656
    # Parse the time arguments
 
657
    try:
 
658
        options.timeout = string_to_delta(options.timeout)
 
659
    except ValueError:
 
660
        parser.error("option --timeout: Unparseable time")
 
661
    try:
 
662
        options.interval = string_to_delta(options.interval)
 
663
    except ValueError:
 
664
        parser.error("option --interval: Unparseable time")
 
665
    
 
666
    # Parse config file
 
667
    defaults = { "checker": "fping -q -- %%(fqdn)s" }
 
668
    client_config = ConfigParser.SafeConfigParser(defaults)
 
669
    #client_config.readfp(open("global.conf"), "global.conf")
 
670
    client_config.read("mandos-clients.conf")
1070
671
    
1071
672
    global main_loop
1072
673
    global bus
1075
676
    DBusGMainLoop(set_as_default=True )
1076
677
    main_loop = gobject.MainLoop()
1077
678
    bus = dbus.SystemBus()
1078
 
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1079
 
                                           avahi.DBUS_PATH_SERVER),
1080
 
                            avahi.DBUS_INTERFACE_SERVER)
 
679
    server = dbus.Interface(
 
680
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
681
            avahi.DBUS_INTERFACE_SERVER )
1081
682
    # End of Avahi example code
1082
 
    if use_dbus:
1083
 
        bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1084
 
    
1085
 
    clients.update(Set(Client(name = section,
1086
 
                              config
1087
 
                              = dict(client_config.items(section)),
1088
 
                              use_dbus = use_dbus)
 
683
    
 
684
    debug = options.debug
 
685
    
 
686
    if debug:
 
687
        console = logging.StreamHandler()
 
688
        # console.setLevel(logging.DEBUG)
 
689
        console.setFormatter(logging.Formatter\
 
690
                             ('%(levelname)s: %(message)s'))
 
691
        logger.addHandler(console)
 
692
        del console
 
693
    
 
694
    clients = Set()
 
695
    def remove_from_clients(client):
 
696
        clients.remove(client)
 
697
        if not clients:
 
698
            logger.debug(u"No clients left, exiting")
 
699
            killme()
 
700
    
 
701
    clients.update(Set(Client(name=section, options=options,
 
702
                              stop_hook = remove_from_clients,
 
703
                              **(dict(client_config\
 
704
                                      .items(section))))
1089
705
                       for section in client_config.sections()))
1090
 
    if not clients:
1091
 
        logger.warning(u"No clients defined")
1092
 
    
1093
 
    if debug:
1094
 
        # Redirect stdin so all checkers get /dev/null
1095
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1096
 
        os.dup2(null, sys.stdin.fileno())
1097
 
        if null > 2:
1098
 
            os.close(null)
1099
 
    else:
1100
 
        # No console logging
1101
 
        logger.removeHandler(console)
1102
 
        # Close all input and output, do double fork, etc.
1103
 
        daemon()
1104
 
    
1105
 
    try:
1106
 
        pid = os.getpid()
1107
 
        pidfile.write(str(pid) + "\n")
1108
 
        pidfile.close()
1109
 
        del pidfile
1110
 
    except IOError:
1111
 
        logger.error(u"Could not write to file %r with PID %d",
1112
 
                     pidfilename, pid)
1113
 
    except NameError:
1114
 
        # "pidfile" was never created
1115
 
        pass
1116
 
    del pidfilename
 
706
    
 
707
    if not debug:
 
708
        daemon(False, False)
1117
709
    
1118
710
    def cleanup():
1119
711
        "Cleanup function; run on exit"
1126
718
        
1127
719
        while clients:
1128
720
            client = clients.pop()
1129
 
            client.disable_hook = None
1130
 
            client.disable()
 
721
            client.stop_hook = None
 
722
            client.stop()
1131
723
    
1132
724
    atexit.register(cleanup)
1133
725
    
1134
726
    if not debug:
1135
727
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1136
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1137
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1138
 
    
1139
 
    if use_dbus:
1140
 
        class MandosServer(dbus.service.Object):
1141
 
            """A D-Bus proxy object"""
1142
 
            def __init__(self):
1143
 
                dbus.service.Object.__init__(self, bus, "/")
1144
 
            _interface = u"se.bsnet.fukt.Mandos"
1145
 
            
1146
 
            @dbus.service.signal(_interface, signature="oa{sv}")
1147
 
            def ClientAdded(self, objpath, properties):
1148
 
                "D-Bus signal"
1149
 
                pass
1150
 
            
1151
 
            @dbus.service.signal(_interface, signature="os")
1152
 
            def ClientRemoved(self, objpath, name):
1153
 
                "D-Bus signal"
1154
 
                pass
1155
 
            
1156
 
            @dbus.service.method(_interface, out_signature="ao")
1157
 
            def GetAllClients(self):
1158
 
                "D-Bus method"
1159
 
                return dbus.Array(c.dbus_object_path for c in clients)
1160
 
            
1161
 
            @dbus.service.method(_interface, out_signature="a{oa{sv}}")
1162
 
            def GetAllClientsWithProperties(self):
1163
 
                "D-Bus method"
1164
 
                return dbus.Dictionary(
1165
 
                    ((c.dbus_object_path, c.GetAllProperties())
1166
 
                     for c in clients),
1167
 
                    signature="oa{sv}")
1168
 
            
1169
 
            @dbus.service.method(_interface, in_signature="o")
1170
 
            def RemoveClient(self, object_path):
1171
 
                "D-Bus method"
1172
 
                for c in clients:
1173
 
                    if c.dbus_object_path == object_path:
1174
 
                        clients.remove(c)
1175
 
                        # Don't signal anything except ClientRemoved
1176
 
                        c.use_dbus = False
1177
 
                        c.disable()
1178
 
                        # Emit D-Bus signal
1179
 
                        self.ClientRemoved(object_path, c.name)
1180
 
                        return
1181
 
                raise KeyError
1182
 
            
1183
 
            del _interface
1184
 
        
1185
 
        mandos_server = MandosServer()
 
728
    signal.signal(signal.SIGHUP, lambda signum, frame: killme())
 
729
    signal.signal(signal.SIGTERM, lambda signum, frame: killme())
1186
730
    
1187
731
    for client in clients:
1188
 
        if use_dbus:
1189
 
            # Emit D-Bus signal
1190
 
            mandos_server.ClientAdded(client.dbus_object_path,
1191
 
                                      client.GetAllProperties())
1192
 
        client.enable()
1193
 
    
1194
 
    tcp_server.enable()
1195
 
    tcp_server.server_activate()
1196
 
    
1197
 
    # Find out what port we got
1198
 
    service.port = tcp_server.socket.getsockname()[1]
1199
 
    if use_ipv6:
1200
 
        logger.info(u"Now listening on address %r, port %d,"
1201
 
                    " flowinfo %d, scope_id %d"
1202
 
                    % tcp_server.socket.getsockname())
1203
 
    else:                       # IPv4
1204
 
        logger.info(u"Now listening on address %r, port %d"
1205
 
                    % tcp_server.socket.getsockname())
1206
 
    
1207
 
    #service.interface = tcp_server.socket.getsockname()[3]
1208
 
    
1209
 
    try:
1210
 
        # From the Avahi example code
1211
 
        server.connect_to_signal("StateChanged", server_state_changed)
1212
 
        try:
1213
 
            server_state_changed(server.GetState())
1214
 
        except dbus.exceptions.DBusException, error:
1215
 
            logger.critical(u"DBusException: %s", error)
1216
 
            sys.exit(1)
1217
 
        # End of Avahi example code
1218
 
        
1219
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1220
 
                             lambda *args, **kwargs:
1221
 
                             (tcp_server.handle_request
1222
 
                              (*args[2:], **kwargs) or True))
1223
 
        
1224
 
        logger.debug(u"Starting main loop")
 
732
        client.start()
 
733
    
 
734
    tcp_server = IPv6_TCPServer((options.address, options.port),
 
735
                                tcp_handler,
 
736
                                options=options,
 
737
                                clients=clients)
 
738
    # Find out what random port we got
 
739
    global servicePort
 
740
    servicePort = tcp_server.socket.getsockname()[1]
 
741
    logger.debug(u"Now listening on port %d", servicePort)
 
742
    
 
743
    if options.interface is not None:
 
744
        global serviceInterface
 
745
        serviceInterface = if_nametoindex(options.interface)
 
746
    
 
747
    # From the Avahi example code
 
748
    server.connect_to_signal("StateChanged", server_state_changed)
 
749
    try:
 
750
        server_state_changed(server.GetState())
 
751
    except dbus.exceptions.DBusException, error:
 
752
        logger.critical(u"DBusException: %s", error)
 
753
        killme(1)
 
754
    # End of Avahi example code
 
755
    
 
756
    gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
757
                         lambda *args, **kwargs:
 
758
                         tcp_server.handle_request(*args[2:],
 
759
                                                   **kwargs) or True)
 
760
    try:
 
761
        logger.debug("Starting main loop")
 
762
        main_loop_started = True
1225
763
        main_loop.run()
1226
 
    except AvahiError, error:
1227
 
        logger.critical(u"AvahiError: %s", error)
1228
 
        sys.exit(1)
1229
764
    except KeyboardInterrupt:
1230
765
        if debug:
1231
 
            print >> sys.stderr
1232
 
        logger.debug("Server received KeyboardInterrupt")
1233
 
    logger.debug("Server exiting")
 
766
            print
 
767
    
 
768
    sys.exit(exitstatus)
1234
769
 
1235
770
if __name__ == '__main__':
1236
771
    main()