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