/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-20 06:33:48 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080720063348-jscgy5p0itrgvlo8
* mandos-clients.conf ([foo]): Uncommented.
  ([foo]/secret): New.
  ([foo]/secfile): Commented out.
  ([foo]/checker): Changed to "fping -q -- %%(fqdn)s".
  ([foo]/timeout): New.

* server.py: New modeline for Python and Emacs.  Set a logging format.
  (Client.__init__): Bug fix: Choose either the value from the options
                     object or pass the argument through string_to_delta
                     for both "timeout" and "interval".
  (Client.checker_callback): Bug fix: Do not log spurious "Checker for
                             <foo> failed" messages.
  (Client.start_checker): Moved "Starting checker" log message down to
                          just before actually starting the subprocess.
                          Do not redirect the subprocesses' stdout to a
                          pipe.
  (peer_certificate, fingerprint): Added docstrings.
  (entry_group_state_changed): Call "killme()" instead of
                               "main_loop.quit()".
  (daemon, killme): New functions.
  (exitstatus, main_loop_started): New global variables.
  (__main__): Removed the "--cert", "--key", "--ca", and "--crl"
              options.  Removed the sleep command from the default
              checker.  Add a console logger in debug mode.  Call
              "killme()" instead of "main_loop.quit()" when there are no
              more clients.  Call "daemon()" if not in debug mode.
              Register "cleanup()" to run at exit.  Ignore some
              signals.  Catch DBusException to detect another running
              server and exit cleanly.  Exit with "exitstatus".
  (cleanup): New function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
server.py
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
# 
4
 
# Mandos server - give out binary blobs to connecting clients.
5
 
# 
6
 
# This program is partly derived from an example program for an Avahi
7
 
# service publisher, downloaded from
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".
12
 
# 
13
 
# Everything else is
14
 
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
15
 
# 
16
 
# This program is free software: you can redistribute it and/or modify
17
 
# it under the terms of the GNU General Public License as published by
18
 
# the Free Software Foundation, either version 3 of the License, or
19
 
# (at your option) any later version.
20
 
#
21
 
#     This program is distributed in the hope that it will be useful,
22
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
23
 
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24
 
#     GNU General Public License for more details.
25
 
# 
26
 
# You should have received a copy of the GNU General Public License
27
 
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
28
 
# 
29
 
# Contact the authors at <mandos@fukt.bsnet.se>.
30
 
# 
31
3
 
32
4
from __future__ import division
33
5
 
52
24
import subprocess
53
25
import atexit
54
26
import stat
55
 
import logging
56
 
import logging.handlers
57
27
 
58
28
import dbus
59
29
import gobject
61
31
from dbus.mainloop.glib import DBusGMainLoop
62
32
import ctypes
63
33
 
 
34
import logging
 
35
import logging.handlers
64
36
 
65
37
logger = logging.Logger('mandos')
66
38
syslogger = logging.handlers.SysLogHandler\
70
42
logger.addHandler(syslogger)
71
43
del syslogger
72
44
 
73
 
 
74
 
class AvahiError(Exception):
75
 
    def __init__(self, value):
76
 
        self.value = value
77
 
    def __str__(self):
78
 
        return repr(self.value)
79
 
 
80
 
class AvahiServiceError(AvahiError):
81
 
    pass
82
 
 
83
 
class AvahiGroupError(AvahiError):
84
 
    pass
85
 
 
86
 
 
87
 
class AvahiService(object):
88
 
    """An Avahi (Zeroconf) service.
89
 
    Attributes:
90
 
    interface: integer; avahi.IF_UNSPEC or an interface index.
91
 
               Used to optionally bind to the specified interface.
92
 
    name: string; Example: 'Mandos'
93
 
    type: string; Example: '_mandos._tcp'.
94
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
95
 
    port: integer; what port to announce
96
 
    TXT: list of strings; TXT record for the service
97
 
    domain: string; Domain to publish on, default to .local if empty.
98
 
    host: string; Host to publish records for, default is localhost
99
 
    max_renames: integer; maximum number of renames
100
 
    rename_count: integer; counter so we only rename after collisions
101
 
                  a sensible number of times
102
 
    """
103
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
104
 
                 type = None, port = None, TXT = None, domain = "",
105
 
                 host = "", max_renames = 12):
106
 
        self.interface = interface
107
 
        self.name = name
108
 
        self.type = type
109
 
        self.port = port
110
 
        if TXT is None:
111
 
            self.TXT = []
112
 
        else:
113
 
            self.TXT = TXT
114
 
        self.domain = domain
115
 
        self.host = host
116
 
        self.rename_count = 0
117
 
    def rename(self):
118
 
        """Derived from the Avahi example code"""
119
 
        if self.rename_count >= self.max_renames:
120
 
            logger.critical(u"No suitable service name found after %i"
121
 
                            u" retries, exiting.", rename_count)
122
 
            raise AvahiServiceError("Too many renames")
123
 
        name = server.GetAlternativeServiceName(name)
124
 
        logger.error(u"Changing name to %r ...", name)
125
 
        self.remove()
126
 
        self.add()
127
 
        self.rename_count += 1
128
 
    def remove(self):
129
 
        """Derived from the Avahi example code"""
130
 
        if group is not None:
131
 
            group.Reset()
132
 
    def add(self):
133
 
        """Derived from the Avahi example code"""
134
 
        global group
135
 
        if group is None:
136
 
            group = dbus.Interface\
137
 
                    (bus.get_object(avahi.DBUS_NAME,
138
 
                                    server.EntryGroupNew()),
139
 
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
140
 
            group.connect_to_signal('StateChanged',
141
 
                                    entry_group_state_changed)
142
 
        logger.debug(u"Adding service '%s' of type '%s' ...",
143
 
                     service.name, service.type)
144
 
        group.AddService(
145
 
                self.interface,         # interface
146
 
                avahi.PROTO_INET6,      # protocol
147
 
                dbus.UInt32(0),         # flags
148
 
                self.name, self.type,
149
 
                self.domain, self.host,
150
 
                dbus.UInt16(self.port),
151
 
                avahi.string_array_to_txt_array(self.TXT))
152
 
        group.Commit()
153
 
 
154
 
# From the Avahi example code:
155
 
group = None                            # our entry group
 
45
# This variable is used to optionally bind to a specified interface.
 
46
# It is a global variable to fit in with the other variables from the
 
47
# Avahi server example code.
 
48
serviceInterface = avahi.IF_UNSPEC
 
49
# From the Avahi server example code:
 
50
serviceName = "Mandos"
 
51
serviceType = "_mandos._tcp" # http://www.dns-sd.org/ServiceTypes.html
 
52
servicePort = None                      # Not known at startup
 
53
serviceTXT = []                         # TXT record for the service
 
54
domain = ""                  # Domain to publish on, default to .local
 
55
host = ""          # Host to publish records for, default to localhost
 
56
group = None #our entry group
 
57
rename_count = 12       # Counter so we only rename after collisions a
 
58
                        # sensible number of times
156
59
# End of Avahi example code
157
60
 
158
61
 
163
66
    fingerprint: string (40 or 32 hexadecimal digits); used to
164
67
                 uniquely identify the client
165
68
    secret:    bytestring; sent verbatim (over TLS) to client
166
 
    host:      string; available for use by the checker command
167
 
    created:   datetime.datetime(); object creation, not client host
168
 
    last_checked_ok: datetime.datetime() or None if not yet checked OK
169
 
    timeout:   datetime.timedelta(); How long from last_checked_ok
170
 
                                     until this client is invalid
 
69
    fqdn:      string (FQDN); available for use by the checker command
 
70
    created:   datetime.datetime()
 
71
    last_seen: datetime.datetime() or None if not yet seen
 
72
    timeout:   datetime.timedelta(); How long from last_seen until
 
73
                                     this client is invalid
171
74
    interval:  datetime.timedelta(); How often to start a new checker
172
75
    stop_hook: If set, called by stop() as stop_hook(self)
173
76
    checker:   subprocess.Popen(); a running checker process used
174
77
                                   to see if the client lives.
175
 
                                   'None' if no process is running.
 
78
                                   Is None if no process is running.
176
79
    checker_initiator_tag: a gobject event source tag, or None
177
80
    stop_initiator_tag:    - '' -
178
81
    checker_callback_tag:  - '' -
179
82
    checker_command: string; External command which is run to check if
180
 
                     client lives.  %() expansions are done at
 
83
                     client lives.  %()s expansions are done at
181
84
                     runtime with vars(self) as dict, so that for
182
85
                     instance %(name)s can be used in the command.
183
86
    Private attibutes:
184
87
    _timeout: Real variable for 'timeout'
185
88
    _interval: Real variable for 'interval'
186
 
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
89
    _timeout_milliseconds: Used by gobject.timeout_add()
187
90
    _interval_milliseconds: - '' -
188
91
    """
189
92
    def _set_timeout(self, timeout):
209
112
    interval = property(lambda self: self._interval,
210
113
                        _set_interval)
211
114
    del _set_interval
212
 
    def __init__(self, name = None, stop_hook=None, config={}):
213
 
        """Note: the 'checker' key in 'config' sets the
214
 
        'checker_command' attribute and *not* the 'checker'
215
 
        attribute."""
 
115
    def __init__(self, name=None, options=None, stop_hook=None,
 
116
                 fingerprint=None, secret=None, secfile=None,
 
117
                 fqdn=None, timeout=None, interval=-1, checker=None):
216
118
        self.name = name
217
 
        logger.debug(u"Creating client %r", self.name)
218
 
        # Uppercase and remove spaces from fingerprint for later
219
 
        # comparison purposes with return value from the fingerprint()
220
 
        # function
221
 
        self.fingerprint = config["fingerprint"].upper()\
222
 
                           .replace(u" ", u"")
223
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
224
 
        if "secret" in config:
225
 
            self.secret = config["secret"].decode(u"base64")
226
 
        elif "secfile" in config:
227
 
            sf = open(config["secfile"])
 
119
        # Uppercase and remove spaces from fingerprint
 
120
        # for later comparison purposes with return value of
 
121
        # the fingerprint() function
 
122
        self.fingerprint = fingerprint.upper().replace(u" ", u"")
 
123
        if secret:
 
124
            self.secret = secret.decode(u"base64")
 
125
        elif secfile:
 
126
            sf = open(secfile)
228
127
            self.secret = sf.read()
229
128
            sf.close()
230
129
        else:
231
 
            raise TypeError(u"No secret or secfile for client %s"
232
 
                            % self.name)
233
 
        self.host = config.get("host", "")
 
130
            raise RuntimeError(u"No secret or secfile for client %s"
 
131
                               % self.name)
 
132
        self.fqdn = fqdn                # string
234
133
        self.created = datetime.datetime.now()
235
 
        self.last_checked_ok = None
236
 
        self.timeout = string_to_delta(config["timeout"])
237
 
        self.interval = string_to_delta(config["interval"])
 
134
        self.last_seen = None
 
135
        if timeout is None:
 
136
            self.timeout = options.timeout
 
137
        else:
 
138
            self.timeout = string_to_delta(timeout)
 
139
        if interval == -1:
 
140
            self.interval = options.interval
 
141
        else:
 
142
            self.interval = string_to_delta(interval)
238
143
        self.stop_hook = stop_hook
239
144
        self.checker = None
240
145
        self.checker_initiator_tag = None
241
146
        self.stop_initiator_tag = None
242
147
        self.checker_callback_tag = None
243
 
        self.check_command = config["checker"]
 
148
        self.check_command = checker
244
149
    def start(self):
245
 
        """Start this client's checker and timeout hooks"""
 
150
        """Start this clients checker and timeout hooks"""
246
151
        # Schedule a new checker to be started an 'interval' from now,
247
152
        # and every interval from then on.
248
153
        self.checker_initiator_tag = gobject.timeout_add\
256
161
                                   self.stop)
257
162
    def stop(self):
258
163
        """Stop this client.
259
 
        The possibility that a client might be restarted is left open,
260
 
        but not currently used."""
261
 
        # If this client doesn't have a secret, it is already stopped.
262
 
        if hasattr(self, "secret") and self.secret:
263
 
            logger.info(u"Stopping client %s", self.name)
264
 
            self.secret = None
265
 
        else:
266
 
            return False
267
 
        if getattr(self, "stop_initiator_tag", False):
 
164
        The possibility that this client might be restarted is left
 
165
        open, but not currently used."""
 
166
        logger.debug(u"Stopping client %s", self.name)
 
167
        self.secret = None
 
168
        if self.stop_initiator_tag:
268
169
            gobject.source_remove(self.stop_initiator_tag)
269
170
            self.stop_initiator_tag = None
270
 
        if getattr(self, "checker_initiator_tag", False):
 
171
        if self.checker_initiator_tag:
271
172
            gobject.source_remove(self.checker_initiator_tag)
272
173
            self.checker_initiator_tag = None
273
174
        self.stop_checker()
276
177
        # Do not run this again if called by a gobject.timeout_add
277
178
        return False
278
179
    def __del__(self):
279
 
        self.stop_hook = None
280
 
        self.stop()
 
180
        # Some code duplication here and in stop()
 
181
        if hasattr(self, "stop_initiator_tag") \
 
182
               and self.stop_initiator_tag:
 
183
            gobject.source_remove(self.stop_initiator_tag)
 
184
            self.stop_initiator_tag = None
 
185
        if hasattr(self, "checker_initiator_tag") \
 
186
               and self.checker_initiator_tag:
 
187
            gobject.source_remove(self.checker_initiator_tag)
 
188
            self.checker_initiator_tag = None
 
189
        self.stop_checker()
281
190
    def checker_callback(self, pid, condition):
282
191
        """The checker has completed, so take appropriate actions."""
283
192
        now = datetime.datetime.now()
284
 
        self.checker_callback_tag = None
285
 
        self.checker = None
286
193
        if os.WIFEXITED(condition) \
287
194
               and (os.WEXITSTATUS(condition) == 0):
288
 
            logger.info(u"Checker for %(name)s succeeded",
289
 
                        vars(self))
290
 
            self.last_checked_ok = now
 
195
            logger.debug(u"Checker for %(name)s succeeded",
 
196
                         vars(self))
 
197
            self.last_seen = now
291
198
            gobject.source_remove(self.stop_initiator_tag)
292
199
            self.stop_initiator_tag = gobject.timeout_add\
293
200
                                      (self._timeout_milliseconds,
296
203
            logger.warning(u"Checker for %(name)s crashed?",
297
204
                           vars(self))
298
205
        else:
299
 
            logger.info(u"Checker for %(name)s failed",
300
 
                        vars(self))
 
206
            logger.debug(u"Checker for %(name)s failed",
 
207
                         vars(self))
 
208
            self.checker = None
 
209
        self.checker_callback_tag = None
301
210
    def start_checker(self):
302
211
        """Start a new checker subprocess if one is not running.
303
212
        If a checker already exists, leave it running and do
304
213
        nothing."""
305
 
        # The reason for not killing a running checker is that if we
306
 
        # did that, then if a checker (for some reason) started
307
 
        # running slowly and taking more than 'interval' time, the
308
 
        # client would inevitably timeout, since no checker would get
309
 
        # a chance to run to completion.  If we instead leave running
310
 
        # checkers alone, the checker would have to take more time
311
 
        # than 'timeout' for the client to be declared invalid, which
312
 
        # is as it should be.
313
214
        if self.checker is None:
314
215
            try:
315
 
                # In case check_command has exactly one % operator
316
 
                command = self.check_command % self.host
 
216
                command = self.check_command % self.fqdn
317
217
            except TypeError:
318
 
                # Escape attributes for the shell
319
218
                escaped_attrs = dict((key, re.escape(str(val)))
320
219
                                     for key, val in
321
220
                                     vars(self).iteritems())
322
221
                try:
323
222
                    command = self.check_command % escaped_attrs
324
223
                except TypeError, error:
325
 
                    logger.error(u'Could not format string "%s":'
326
 
                                 u' %s', self.check_command, error)
 
224
                    logger.critical(u'Could not format string "%s":'
 
225
                                    u' %s', self.check_command, error)
327
226
                    return True # Try again later
328
227
            try:
329
 
                logger.info(u"Starting checker %r for %s",
330
 
                            command, self.name)
331
 
                self.checker = subprocess.Popen(command,
332
 
                                                close_fds=True,
333
 
                                                shell=True, cwd="/")
 
228
                logger.debug(u"Starting checker %r for %s",
 
229
                             command, self.name)
 
230
                self.checker = subprocess.\
 
231
                               Popen(command,
 
232
                                     close_fds=True, shell=True,
 
233
                                     cwd="/")
334
234
                self.checker_callback_tag = gobject.child_watch_add\
335
235
                                            (self.checker.pid,
336
236
                                             self.checker_callback)
341
241
        return True
342
242
    def stop_checker(self):
343
243
        """Force the checker process, if any, to stop."""
344
 
        if self.checker_callback_tag:
345
 
            gobject.source_remove(self.checker_callback_tag)
346
 
            self.checker_callback_tag = None
347
 
        if getattr(self, "checker", None) is None:
 
244
        if not hasattr(self, "checker") or self.checker is None:
348
245
            return
349
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
350
 
        try:
351
 
            os.kill(self.checker.pid, signal.SIGTERM)
352
 
            #os.sleep(0.5)
353
 
            #if self.checker.poll() is None:
354
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
355
 
        except OSError, error:
356
 
            if error.errno != errno.ESRCH: # No such process
357
 
                raise
 
246
        gobject.source_remove(self.checker_callback_tag)
 
247
        self.checker_callback_tag = None
 
248
        os.kill(self.checker.pid, signal.SIGTERM)
 
249
        if self.checker.poll() is None:
 
250
            os.kill(self.checker.pid, signal.SIGKILL)
358
251
        self.checker = None
359
 
    def still_valid(self):
 
252
    def still_valid(self, now=None):
360
253
        """Has the timeout not yet passed for this client?"""
361
 
        now = datetime.datetime.now()
362
 
        if self.last_checked_ok is None:
 
254
        if now is None:
 
255
            now = datetime.datetime.now()
 
256
        if self.last_seen is None:
363
257
            return now < (self.created + self.timeout)
364
258
        else:
365
 
            return now < (self.last_checked_ok + self.timeout)
 
259
            return now < (self.last_seen + self.timeout)
366
260
 
367
261
 
368
262
def peer_certificate(session):
369
 
    "Return the peer's OpenPGP certificate as a bytestring"
 
263
    "Return an OpenPGP data packet string for the peer's certificate"
370
264
    # If not an OpenPGP certificate...
371
265
    if gnutls.library.functions.gnutls_certificate_type_get\
372
266
            (session._c_object) \
383
277
 
384
278
 
385
279
def fingerprint(openpgp):
386
 
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
280
    "Convert an OpenPGP data string to a hexdigit fingerprint string"
 
281
    # New empty GnuTLS certificate
 
282
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
283
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
284
        (ctypes.byref(crt))
387
285
    # New GnuTLS "datum" with the OpenPGP public key
388
286
    datum = gnutls.library.types.gnutls_datum_t\
389
287
        (ctypes.cast(ctypes.c_char_p(openpgp),
390
288
                     ctypes.POINTER(ctypes.c_ubyte)),
391
289
         ctypes.c_uint(len(openpgp)))
392
 
    # New empty GnuTLS certificate
393
 
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
394
 
    gnutls.library.functions.gnutls_openpgp_crt_init\
395
 
        (ctypes.byref(crt))
396
290
    # Import the OpenPGP public key into the certificate
397
 
    gnutls.library.functions.gnutls_openpgp_crt_import\
398
 
                    (crt, ctypes.byref(datum),
399
 
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
291
    ret = gnutls.library.functions.gnutls_openpgp_crt_import\
 
292
        (crt,
 
293
         ctypes.byref(datum),
 
294
         gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
400
295
    # New buffer for the fingerprint
401
296
    buffer = ctypes.create_string_buffer(20)
402
297
    buffer_length = ctypes.c_size_t()
418
313
    Note: This will run in its own forked process."""
419
314
    
420
315
    def handle(self):
421
 
        logger.info(u"TCP connection from: %s",
 
316
        logger.debug(u"TCP connection from: %s",
422
317
                     unicode(self.client_address))
423
 
        session = gnutls.connection.ClientSession\
424
 
                  (self.request, gnutls.connection.X509Credentials())
425
 
        
426
 
        line = self.request.makefile().readline()
427
 
        logger.debug(u"Protocol version: %r", line)
428
 
        try:
429
 
            if int(line.strip().split()[0]) > 1:
430
 
                raise RuntimeError
431
 
        except (ValueError, IndexError, RuntimeError), error:
432
 
            logger.error(u"Unknown protocol version: %s", error)
433
 
            return
434
 
        
435
 
        # Note: gnutls.connection.X509Credentials is really a generic
436
 
        # GnuTLS certificate credentials object so long as no X.509
437
 
        # keys are added to it.  Therefore, we can use it here despite
438
 
        # using OpenPGP certificates.
 
318
        session = gnutls.connection.ClientSession(self.request,
 
319
                                                  gnutls.connection.\
 
320
                                                  X509Credentials())
439
321
        
440
322
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
441
323
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
442
324
        #                "+DHE-DSS"))
443
 
        priority = "NORMAL"             # Fallback default, since this
444
 
                                        # MUST be set.
445
 
        if self.server.settings["priority"]:
446
 
            priority = self.server.settings["priority"]
 
325
        priority = "SECURE256"
 
326
        
447
327
        gnutls.library.functions.gnutls_priority_set_direct\
448
328
            (session._c_object, priority, None);
449
329
        
450
330
        try:
451
331
            session.handshake()
452
332
        except gnutls.errors.GNUTLSError, error:
453
 
            logger.warning(u"Handshake failed: %s", error)
 
333
            logger.debug(u"Handshake failed: %s", error)
454
334
            # Do not run session.bye() here: the session is not
455
335
            # established.  Just abandon the request.
456
336
            return
457
337
        try:
458
338
            fpr = fingerprint(peer_certificate(session))
459
339
        except (TypeError, gnutls.errors.GNUTLSError), error:
460
 
            logger.warning(u"Bad certificate: %s", error)
 
340
            logger.debug(u"Bad certificate: %s", error)
461
341
            session.bye()
462
342
            return
463
343
        logger.debug(u"Fingerprint: %s", fpr)
464
344
        client = None
465
 
        for c in self.server.clients:
 
345
        for c in clients:
466
346
            if c.fingerprint == fpr:
467
347
                client = c
468
348
                break
469
 
        if not client:
470
 
            logger.warning(u"Client not found for fingerprint: %s",
471
 
                           fpr)
472
 
            session.bye()
473
 
            return
474
349
        # Have to check if client.still_valid(), since it is possible
475
350
        # that the client timed out while establishing the GnuTLS
476
351
        # session.
477
 
        if not client.still_valid():
478
 
            logger.warning(u"Client %(name)s is invalid",
479
 
                           vars(client))
 
352
        if (not client) or (not client.still_valid()):
 
353
            if client:
 
354
                logger.debug(u"Client %(name)s is invalid",
 
355
                             vars(client))
 
356
            else:
 
357
                logger.debug(u"Client not found for fingerprint: %s",
 
358
                             fpr)
480
359
            session.bye()
481
360
            return
482
361
        sent_size = 0
492
371
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
493
372
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
494
373
    Attributes:
495
 
        settings:       Server settings
 
374
        options:        Command line options
496
375
        clients:        Set() of Client objects
497
376
    """
498
377
    address_family = socket.AF_INET6
499
378
    def __init__(self, *args, **kwargs):
500
 
        if "settings" in kwargs:
501
 
            self.settings = kwargs["settings"]
502
 
            del kwargs["settings"]
 
379
        if "options" in kwargs:
 
380
            self.options = kwargs["options"]
 
381
            del kwargs["options"]
503
382
        if "clients" in kwargs:
504
383
            self.clients = kwargs["clients"]
505
384
            del kwargs["clients"]
508
387
        """This overrides the normal server_bind() function
509
388
        to bind to an interface if one was specified, and also NOT to
510
389
        bind to an address or port if they were not specified."""
511
 
        if self.settings["interface"]:
512
 
            # 25 is from /usr/include/asm-i486/socket.h
513
 
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
390
        if self.options.interface:
 
391
            if not hasattr(socket, "SO_BINDTODEVICE"):
 
392
                # From /usr/include/asm-i486/socket.h
 
393
                socket.SO_BINDTODEVICE = 25
514
394
            try:
515
395
                self.socket.setsockopt(socket.SOL_SOCKET,
516
 
                                       SO_BINDTODEVICE,
517
 
                                       self.settings["interface"])
 
396
                                       socket.SO_BINDTODEVICE,
 
397
                                       self.options.interface)
518
398
            except socket.error, error:
519
399
                if error[0] == errno.EPERM:
520
 
                    logger.error(u"No permission to"
521
 
                                 u" bind to interface %s",
522
 
                                 self.settings["interface"])
 
400
                    logger.warning(u"No permission to"
 
401
                                   u" bind to interface %s",
 
402
                                   self.options.interface)
523
403
                else:
524
404
                    raise error
525
405
        # Only bind(2) the socket if we really need to.
528
408
                in6addr_any = "::"
529
409
                self.server_address = (in6addr_any,
530
410
                                       self.server_address[1])
531
 
            elif not self.server_address[1]:
 
411
            elif self.server_address[1] is None:
532
412
                self.server_address = (self.server_address[0],
533
413
                                       0)
534
 
#                 if self.settings["interface"]:
535
 
#                     self.server_address = (self.server_address[0],
536
 
#                                            0, # port
537
 
#                                            0, # flowinfo
538
 
#                                            if_nametoindex
539
 
#                                            (self.settings
540
 
#                                             ["interface"]))
541
414
            return super(type(self), self).server_bind()
542
415
 
543
416
 
575
448
    return delta
576
449
 
577
450
 
 
451
def add_service():
 
452
    """From the Avahi server example code"""
 
453
    global group, serviceName, serviceType, servicePort, serviceTXT, \
 
454
           domain, host
 
455
    if group is None:
 
456
        group = dbus.Interface(
 
457
                bus.get_object( avahi.DBUS_NAME,
 
458
                                server.EntryGroupNew()),
 
459
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
460
        group.connect_to_signal('StateChanged',
 
461
                                entry_group_state_changed)
 
462
    logger.debug(u"Adding service '%s' of type '%s' ...",
 
463
                 serviceName, serviceType)
 
464
    
 
465
    group.AddService(
 
466
            serviceInterface,           # interface
 
467
            avahi.PROTO_INET6,          # protocol
 
468
            dbus.UInt32(0),             # flags
 
469
            serviceName, serviceType,
 
470
            domain, host,
 
471
            dbus.UInt16(servicePort),
 
472
            avahi.string_array_to_txt_array(serviceTXT))
 
473
    group.Commit()
 
474
 
 
475
 
 
476
def remove_service():
 
477
    """From the Avahi server example code"""
 
478
    global group
 
479
    
 
480
    if not group is None:
 
481
        group.Reset()
 
482
 
 
483
 
578
484
def server_state_changed(state):
579
 
    """Derived from the Avahi example code"""
 
485
    """From the Avahi server example code"""
580
486
    if state == avahi.SERVER_COLLISION:
581
 
        logger.error(u"Server name collision")
582
 
        service.remove()
 
487
        logger.warning(u"Server name collision")
 
488
        remove_service()
583
489
    elif state == avahi.SERVER_RUNNING:
584
 
        service.add()
 
490
        add_service()
585
491
 
586
492
 
587
493
def entry_group_state_changed(state, error):
588
 
    """Derived from the Avahi example code"""
 
494
    """From the Avahi server example code"""
 
495
    global serviceName, server, rename_count
 
496
    
589
497
    logger.debug(u"state change: %i", state)
590
498
    
591
499
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
592
500
        logger.debug(u"Service established.")
593
501
    elif state == avahi.ENTRY_GROUP_COLLISION:
594
 
        logger.warning(u"Service name collision.")
595
 
        service.rename()
 
502
        
 
503
        rename_count = rename_count - 1
 
504
        if rename_count > 0:
 
505
            name = server.GetAlternativeServiceName(name)
 
506
            logger.warning(u"Service name collision, "
 
507
                           u"changing name to '%s' ...", name)
 
508
            remove_service()
 
509
            add_service()
 
510
            
 
511
        else:
 
512
            logger.error(u"No suitable service name found after %i"
 
513
                         u" retries, exiting.", n_rename)
 
514
            killme(1)
596
515
    elif state == avahi.ENTRY_GROUP_FAILURE:
597
 
        logger.critical(u"Error in group state changed %s",
598
 
                        unicode(error))
599
 
        raise AvahiGroupError("State changed: %s", str(error))
 
516
        logger.error(u"Error in group state changed %s",
 
517
                     unicode(error))
 
518
        killme(1)
 
519
 
600
520
 
601
521
def if_nametoindex(interface):
602
 
    """Call the C function if_nametoindex(), or equivalent"""
603
 
    global if_nametoindex
 
522
    """Call the C function if_nametoindex()"""
604
523
    try:
605
 
        if "ctypes.util" not in sys.modules:
606
 
            import ctypes.util
607
 
        if_nametoindex = ctypes.cdll.LoadLibrary\
608
 
            (ctypes.util.find_library("c")).if_nametoindex
 
524
        libc = ctypes.cdll.LoadLibrary("libc.so.6")
 
525
        return libc.if_nametoindex(interface)
609
526
    except (OSError, AttributeError):
610
527
        if "struct" not in sys.modules:
611
528
            import struct
612
529
        if "fcntl" not in sys.modules:
613
530
            import fcntl
614
 
        def if_nametoindex(interface):
615
 
            "Get an interface index the hard way, i.e. using fcntl()"
616
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
617
 
            s = socket.socket()
618
 
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
619
 
                                struct.pack("16s16x", interface))
620
 
            s.close()
621
 
            interface_index = struct.unpack("I", ifreq[16:20])[0]
622
 
            return interface_index
623
 
    return if_nametoindex(interface)
624
 
 
625
 
 
626
 
def daemon(nochdir = False, noclose = False):
 
531
        SIOCGIFINDEX = 0x8933      # From /usr/include/linux/sockios.h
 
532
        s = socket.socket()
 
533
        ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
534
                            struct.pack("16s16x", interface))
 
535
        s.close()
 
536
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
537
        return interface_index
 
538
 
 
539
 
 
540
def daemon(nochdir, noclose):
627
541
    """See daemon(3).  Standard BSD Unix function.
628
542
    This should really exist as os.daemon, but it doesn't (yet)."""
629
543
    if os.fork():
631
545
    os.setsid()
632
546
    if not nochdir:
633
547
        os.chdir("/")
634
 
    if os.fork():
635
 
        sys.exit()
636
548
    if not noclose:
637
549
        # Close all standard open file descriptors
638
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
550
        null = os.open("/dev/null", os.O_NOCTTY | os.O_RDWR)
639
551
        if not stat.S_ISCHR(os.fstat(null).st_mode):
640
552
            raise OSError(errno.ENODEV,
641
553
                          "/dev/null not a character device")
646
558
            os.close(null)
647
559
 
648
560
 
649
 
def main():
650
 
    global main_loop_started
 
561
def killme(status = 0):
 
562
    logger.debug("Stopping server with exit status %d", status)
 
563
    exitstatus = status
 
564
    if main_loop_started:
 
565
        main_loop.quit()
 
566
    else:
 
567
        sys.exit(status)
 
568
 
 
569
 
 
570
if __name__ == '__main__':
 
571
    exitstatus = 0
651
572
    main_loop_started = False
652
 
    
653
573
    parser = OptionParser()
654
574
    parser.add_option("-i", "--interface", type="string",
655
 
                      metavar="IF", help="Bind to interface IF")
656
 
    parser.add_option("-a", "--address", type="string",
657
 
                      help="Address to listen for requests on")
658
 
    parser.add_option("-p", "--port", type="int",
 
575
                      default=None, metavar="IF",
 
576
                      help="Bind to interface IF")
 
577
    parser.add_option("-p", "--port", type="int", default=None,
659
578
                      help="Port number to receive requests on")
 
579
    parser.add_option("--timeout", type="string", # Parsed later
 
580
                      default="1h",
 
581
                      help="Amount of downtime allowed for clients")
 
582
    parser.add_option("--interval", type="string", # Parsed later
 
583
                      default="5m",
 
584
                      help="How often to check that a client is up")
660
585
    parser.add_option("--check", action="store_true", default=False,
661
586
                      help="Run self-test")
662
 
    parser.add_option("--debug", action="store_true",
663
 
                      help="Debug mode; run in foreground and log to"
664
 
                      " terminal")
665
 
    parser.add_option("--priority", type="string", help="GnuTLS"
666
 
                      " priority string (see GnuTLS documentation)")
667
 
    parser.add_option("--servicename", type="string", metavar="NAME",
668
 
                      help="Zeroconf service name")
669
 
    parser.add_option("--configdir", type="string",
670
 
                      default="/etc/mandos", metavar="DIR",
671
 
                      help="Directory to search for configuration"
672
 
                      " files")
 
587
    parser.add_option("--debug", action="store_true", default=False,
 
588
                      help="Debug mode")
673
589
    (options, args) = parser.parse_args()
674
590
    
675
591
    if options.check:
677
593
        doctest.testmod()
678
594
        sys.exit()
679
595
    
680
 
    # Default values for config file for server-global settings
681
 
    server_defaults = { "interface": "",
682
 
                        "address": "",
683
 
                        "port": "",
684
 
                        "debug": "False",
685
 
                        "priority":
686
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
687
 
                        "servicename": "Mandos",
688
 
                        }
689
 
    
690
 
    # Parse config file for server-global settings
691
 
    server_config = ConfigParser.SafeConfigParser(server_defaults)
692
 
    del server_defaults
693
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
694
 
    server_section = "server"
695
 
    # Convert the SafeConfigParser object to a dict
696
 
    server_settings = dict(server_config.items(server_section))
697
 
    # Use getboolean on the boolean config option
698
 
    server_settings["debug"] = server_config.getboolean\
699
 
                               (server_section, "debug")
700
 
    del server_config
701
 
    
702
 
    # Override the settings from the config file with command line
703
 
    # options, if set.
704
 
    for option in ("interface", "address", "port", "debug",
705
 
                   "priority", "servicename", "configdir"):
706
 
        value = getattr(options, option)
707
 
        if value is not None:
708
 
            server_settings[option] = value
709
 
    del options
710
 
    # Now we have our good server settings in "server_settings"
711
 
    
712
 
    # Parse config file with clients
713
 
    client_defaults = { "timeout": "1h",
714
 
                        "interval": "5m",
715
 
                        "checker": "fping -q -- %%(host)s",
716
 
                        }
717
 
    client_config = ConfigParser.SafeConfigParser(client_defaults)
718
 
    client_config.read(os.path.join(server_settings["configdir"],
719
 
                                    "clients.conf"))
720
 
    
721
 
    global service
722
 
    service = AvahiService(name = server_settings["servicename"],
723
 
                           type = "_mandos._tcp", );
724
 
    if server_settings["interface"]:
725
 
        service.interface = if_nametoindex(server_settings["interface"])
726
 
    
727
 
    global main_loop
728
 
    global bus
729
 
    global server
730
 
    # From the Avahi example code
 
596
    # Parse the time arguments
 
597
    try:
 
598
        options.timeout = string_to_delta(options.timeout)
 
599
    except ValueError:
 
600
        parser.error("option --timeout: Unparseable time")
 
601
    try:
 
602
        options.interval = string_to_delta(options.interval)
 
603
    except ValueError:
 
604
        parser.error("option --interval: Unparseable time")
 
605
    
 
606
    # Parse config file
 
607
    defaults = { "checker": "fping -q -- %%(fqdn)s" }
 
608
    client_config = ConfigParser.SafeConfigParser(defaults)
 
609
    #client_config.readfp(open("secrets.conf"), "secrets.conf")
 
610
    client_config.read("mandos-clients.conf")
 
611
    
 
612
    # From the Avahi server example code
731
613
    DBusGMainLoop(set_as_default=True )
732
614
    main_loop = gobject.MainLoop()
733
615
    bus = dbus.SystemBus()
736
618
            avahi.DBUS_INTERFACE_SERVER )
737
619
    # End of Avahi example code
738
620
    
739
 
    debug = server_settings["debug"]
 
621
    debug = options.debug
740
622
    
741
623
    if debug:
742
624
        console = logging.StreamHandler()
750
632
    def remove_from_clients(client):
751
633
        clients.remove(client)
752
634
        if not clients:
753
 
            logger.critical(u"No clients left, exiting")
754
 
            sys.exit()
 
635
            logger.debug(u"No clients left, exiting")
 
636
            killme()
755
637
    
756
 
    clients.update(Set(Client(name = section,
 
638
    clients.update(Set(Client(name=section, options=options,
757
639
                              stop_hook = remove_from_clients,
758
 
                              config
759
 
                              = dict(client_config.items(section)))
 
640
                              **(dict(client_config\
 
641
                                      .items(section))))
760
642
                       for section in client_config.sections()))
761
 
    if not clients:
762
 
        logger.critical(u"No clients defined")
763
 
        sys.exit(1)
764
643
    
765
644
    if not debug:
766
 
        daemon()
767
 
    
768
 
    pidfilename = "/var/run/mandos/mandos.pid"
769
 
    pid = os.getpid()
770
 
    try:
771
 
        pidfile = open(pidfilename, "w")
772
 
        pidfile.write(str(pid) + "\n")
773
 
        pidfile.close()
774
 
        del pidfile
775
 
    except IOError, err:
776
 
        logger.error(u"Could not write %s file with PID %d",
777
 
                     pidfilename, os.getpid())
 
645
        daemon(False, False)
778
646
    
779
647
    def cleanup():
780
648
        "Cleanup function; run on exit"
781
649
        global group
782
 
        # From the Avahi example code
 
650
        # From the Avahi server example code
783
651
        if not group is None:
784
652
            group.Free()
785
653
            group = None
786
654
        # End of Avahi example code
787
655
        
788
 
        while clients:
789
 
            client = clients.pop()
 
656
        for client in clients:
790
657
            client.stop_hook = None
791
658
            client.stop()
792
659
    
794
661
    
795
662
    if not debug:
796
663
        signal.signal(signal.SIGINT, signal.SIG_IGN)
797
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
798
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
664
    signal.signal(signal.SIGHUP, lambda signum, frame: killme())
 
665
    signal.signal(signal.SIGTERM, lambda signum, frame: killme())
799
666
    
800
667
    for client in clients:
801
668
        client.start()
802
669
    
803
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
804
 
                                 server_settings["port"]),
 
670
    tcp_server = IPv6_TCPServer((None, options.port),
805
671
                                tcp_handler,
806
 
                                settings=server_settings,
 
672
                                options=options,
807
673
                                clients=clients)
808
 
    # Find out what port we got
809
 
    service.port = tcp_server.socket.getsockname()[1]
810
 
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
811
 
                u" scope_id %d" % tcp_server.socket.getsockname())
812
 
    
813
 
    #service.interface = tcp_server.socket.getsockname()[3]
814
 
    
815
 
    try:
816
 
        # From the Avahi example code
817
 
        server.connect_to_signal("StateChanged", server_state_changed)
818
 
        try:
819
 
            server_state_changed(server.GetState())
820
 
        except dbus.exceptions.DBusException, error:
821
 
            logger.critical(u"DBusException: %s", error)
822
 
            sys.exit(1)
823
 
        # End of Avahi example code
824
 
        
825
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
826
 
                             lambda *args, **kwargs:
827
 
                             tcp_server.handle_request\
828
 
                             (*args[2:], **kwargs) or True)
829
 
        
830
 
        logger.debug(u"Starting main loop")
 
674
    # Find out what random port we got
 
675
    servicePort = tcp_server.socket.getsockname()[1]
 
676
    logger.debug(u"Now listening on port %d", servicePort)
 
677
    
 
678
    if options.interface is not None:
 
679
        serviceInterface = if_nametoindex(options.interface)
 
680
    
 
681
    # From the Avahi server example code
 
682
    server.connect_to_signal("StateChanged", server_state_changed)
 
683
    try:
 
684
        server_state_changed(server.GetState())
 
685
    except dbus.exceptions.DBusException, error:
 
686
        logger.critical(u"DBusException: %s", error)
 
687
        killme(1)
 
688
    # End of Avahi example code
 
689
    
 
690
    gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
691
                         lambda *args, **kwargs:
 
692
                         tcp_server.handle_request(*args[2:],
 
693
                                                   **kwargs) or True)
 
694
    try:
831
695
        main_loop_started = True
832
696
        main_loop.run()
833
 
    except AvahiError, error:
834
 
        logger.critical(u"AvahiError: %s" + unicode(error))
835
 
        sys.exit(1)
836
697
    except KeyboardInterrupt:
837
698
        if debug:
838
699
            print
839
 
 
840
 
if __name__ == '__main__':
841
 
    main()
 
700
    
 
701
    sys.exit(exitstatus)