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