/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-08-04 20:43:31 UTC
  • mfrom: (24.1.17 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080804204331-zgu42g8ii997h1l2
* ca.pem: Removed.
* cert.pem: - '' -
* client-cert.pem: - '' -
* client-key.pem: - '' -
* crl.pem: - '' -
* key.pem: - '' -

* plugins.d/mandosclient.c (start_mandos_communication): Change "to"
                                    to be a union.  All users changed.

* server.py: Changed log severity for many log messages.
  (Client.__init__): Take all config file settins as a dict instead of
                     as keyword arguments.

Show diffs side-by-side

added added

removed removed

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