/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

merge

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