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