/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to server.py

  • Committer: Teddy Hogeborn
  • Date: 2008-07-19 18:43:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080719184324-iwhoa5in75xa0u2u
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
                       [braxen_client]/password): Removed.
  ([foo]/fingerprint, [braxen_client]/fingerprint): New.
  ([foo]/checker): New.
  ([foo]/secfile): New.
  ([braxen_client]/secret): New.

* server.py: New "--debug" option to set debug flag.  Removed "cert",
             "key", "ca", "crl", and "cred" variables.  Added default
             value for "checker" config file setting.  Do not pass
             credentials to IPv6_TCPServer constructor.
  (debug): New global debug flag.  Used by most debugging output code.
  (Client.__init__): Keyword argument "dn" replaced by "fingerprint",
                     "password" renamed to "secret", and "passfile"
                     renamed to "secfile".  New keyword argument
                     "checker". All callers changed.
  (Client.dn): Removed.
  (Client.fingerprint): New.
  (Client.password): Renamed to "secret"; all users changed.
  (Client.passfile): Renamed to "secfile"; all users changed.
  (Client.timeout, Client.interval): Changed to be properties; now
                                     automatically updates the
                                     "_timeout_milliseconds" and
                                     "_interval_milliseconds" values.
  (Client.timeout_milliseconds): Renamed to "_timeout_milliseconds".
  (Client.interval_milliseconds): Renamed to "_interval_milliseconds".
  (Client.check_command): New.
  (Client.start_checker): Use the new "check_command" attribute.
  (peer_certificate, fingerprint): New functions.

  (tcp_handler.handle): Use ClientSession with empty credentials
                        object instead of ServerSession.  Set gnutls
                        priority string.  Do not verify peer.  Use
                        fingerprint instead of DN when searching for
                        clients.  Bug fix: Loop sending data so even large
                        secret data strings are sent.
  (IPv6_TCPServer.credentials): Removed.
  (if_nametoindex): Do not import ctypes since that is now imported
                    globally.

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
 
# 
31
2
 
32
3
from __future__ import division
33
4
 
50
21
import signal
51
22
from sets import Set
52
23
import subprocess
53
 
import atexit
54
 
import stat
55
 
import logging
56
 
import logging.handlers
57
24
 
58
25
import dbus
59
26
import gobject
61
28
from dbus.mainloop.glib import DBusGMainLoop
62
29
import ctypes
63
30
 
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
 
    """
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
 
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
168
45
# End of Avahi example code
169
46
 
170
47
 
176
53
                 uniquely identify the client
177
54
    secret:    bytestring; sent verbatim (over TLS) to client
178
55
    fqdn:      string (FQDN); available for use by the checker command
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
 
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
183
60
    interval:  datetime.timedelta(); How often to start a new checker
184
61
    stop_hook: If set, called by stop() as stop_hook(self)
185
62
    checker:   subprocess.Popen(); a running checker process used
186
63
                                   to see if the client lives.
187
 
                                   'None' if no process is running.
 
64
                                   Is None if no process is running.
188
65
    checker_initiator_tag: a gobject event source tag, or None
189
66
    stop_initiator_tag:    - '' -
190
67
    checker_callback_tag:  - '' -
191
68
    checker_command: string; External command which is run to check if
192
 
                     client lives.  %() expansions are done at
 
69
                     client lives.  %()s expansions are done at
193
70
                     runtime with vars(self) as dict, so that for
194
71
                     instance %(name)s can be used in the command.
195
72
    Private attibutes:
196
73
    _timeout: Real variable for 'timeout'
197
74
    _interval: Real variable for 'interval'
198
 
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
75
    _timeout_milliseconds: Used by gobject.timeout_add()
199
76
    _interval_milliseconds: - '' -
200
77
    """
201
78
    def _set_timeout(self, timeout):
221
98
    interval = property(lambda self: self._interval,
222
99
                        _set_interval)
223
100
    del _set_interval
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.."""
 
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):
227
104
        self.name = name
228
 
        logger.debug(u"Creating client %r", self.name)
229
105
        # Uppercase and remove spaces from fingerprint
230
106
        # for later comparison purposes with return value of
231
107
        # the fingerprint() 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"])
 
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)
239
113
            self.secret = sf.read()
240
114
            sf.close()
241
115
        else:
242
 
            raise TypeError(u"No secret or secfile for client %s"
243
 
                            % self.name)
244
 
        self.fqdn = config.get("fqdn", "")
 
116
            raise RuntimeError(u"No secret or secfile for client %s"
 
117
                               % self.name)
 
118
        self.fqdn = fqdn                # string
245
119
        self.created = datetime.datetime.now()
246
 
        self.last_checked_ok = None
247
 
        self.timeout = string_to_delta(config["timeout"])
248
 
        self.interval = string_to_delta(config["interval"])
 
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
249
129
        self.stop_hook = stop_hook
250
130
        self.checker = None
251
131
        self.checker_initiator_tag = None
252
132
        self.stop_initiator_tag = None
253
133
        self.checker_callback_tag = None
254
 
        self.check_command = config["checker"]
 
134
        self.check_command = checker
255
135
    def start(self):
256
 
        """Start this client's checker and timeout hooks"""
 
136
        """Start this clients checker and timeout hooks"""
257
137
        # Schedule a new checker to be started an 'interval' from now,
258
138
        # and every interval from then on.
259
139
        self.checker_initiator_tag = gobject.timeout_add\
267
147
                                   self.stop)
268
148
    def stop(self):
269
149
        """Stop this client.
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):
 
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:
279
156
            gobject.source_remove(self.stop_initiator_tag)
280
157
            self.stop_initiator_tag = None
281
 
        if getattr(self, "checker_initiator_tag", False):
 
158
        if self.checker_initiator_tag:
282
159
            gobject.source_remove(self.checker_initiator_tag)
283
160
            self.checker_initiator_tag = None
284
161
        self.stop_checker()
287
164
        # Do not run this again if called by a gobject.timeout_add
288
165
        return False
289
166
    def __del__(self):
290
 
        self.stop_hook = None
291
 
        self.stop()
 
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()
292
177
    def checker_callback(self, pid, condition):
293
178
        """The checker has completed, so take appropriate actions."""
294
179
        now = datetime.datetime.now()
295
 
        self.checker_callback_tag = None
296
 
        self.checker = None
297
180
        if os.WIFEXITED(condition) \
298
181
               and (os.WEXITSTATUS(condition) == 0):
299
 
            logger.info(u"Checker for %(name)s succeeded",
300
 
                        vars(self))
301
 
            self.last_checked_ok = now
 
182
            if debug:
 
183
                sys.stderr.write(u"Checker for %(name)s succeeded\n"
 
184
                                 % vars(self))
 
185
            self.last_seen = now
302
186
            gobject.source_remove(self.stop_initiator_tag)
303
187
            self.stop_initiator_tag = gobject.timeout_add\
304
188
                                      (self._timeout_milliseconds,
305
189
                                       self.stop)
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))
 
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
312
199
    def start_checker(self):
313
200
        """Start a new checker subprocess if one is not running.
314
201
        If a checker already exists, leave it running and do
315
202
        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.
324
203
        if self.checker is None:
 
204
            if debug:
 
205
                sys.stderr.write(u"Starting checker for %s\n"
 
206
                                 % self.name)
325
207
            try:
326
 
                # In case check_command has exactly one % operator
327
208
                command = self.check_command % self.fqdn
328
209
            except TypeError:
329
 
                # Escape attributes for the shell
330
210
                escaped_attrs = dict((key, re.escape(str(val)))
331
211
                                     for key, val in
332
212
                                     vars(self).iteritems())
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
 
213
                command = self.check_command % escaped_attrs
339
214
            try:
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)
 
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)
348
224
            except subprocess.OSError, error:
349
 
                logger.error(u"Failed to start subprocess: %s",
350
 
                             error)
 
225
                sys.stderr.write(u"Failed to start subprocess: %s\n"
 
226
                                 % error)
351
227
        # Re-run this periodically if run by gobject.timeout_add
352
228
        return True
353
229
    def stop_checker(self):
354
230
        """Force the checker process, if any, to stop."""
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:
 
231
        if not hasattr(self, "checker") or self.checker is None:
359
232
            return
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
 
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)
369
238
        self.checker = None
370
 
    def still_valid(self):
 
239
    def still_valid(self, now=None):
371
240
        """Has the timeout not yet passed for this client?"""
372
 
        now = datetime.datetime.now()
373
 
        if self.last_checked_ok is None:
 
241
        if now is None:
 
242
            now = datetime.datetime.now()
 
243
        if self.last_seen is None:
374
244
            return now < (self.created + self.timeout)
375
245
        else:
376
 
            return now < (self.last_checked_ok + self.timeout)
 
246
            return now < (self.last_seen + self.timeout)
377
247
 
378
248
 
379
249
def peer_certificate(session):
380
 
    "Return the peer's OpenPGP certificate as a bytestring"
381
250
    # If not an OpenPGP certificate...
382
251
    if gnutls.library.functions.gnutls_certificate_type_get\
383
252
            (session._c_object) \
394
263
 
395
264
 
396
265
def fingerprint(openpgp):
397
 
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
398
266
    # New empty GnuTLS certificate
399
267
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
400
268
    gnutls.library.functions.gnutls_openpgp_crt_init\
430
298
    Note: This will run in its own forked process."""
431
299
    
432
300
    def handle(self):
433
 
        logger.info(u"TCP connection from: %s",
434
 
                     unicode(self.client_address))
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.
 
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())
451
310
        
452
311
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
453
312
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
454
313
        #                "+DHE-DSS"))
455
 
        priority = "NORMAL"             # Fallback default, since this
456
 
                                        # MUST be set.
457
 
        if self.server.settings["priority"]:
458
 
            priority = self.server.settings["priority"]
 
314
        priority = "SECURE256"
 
315
        
459
316
        gnutls.library.functions.gnutls_priority_set_direct\
460
317
            (session._c_object, priority, None);
461
318
        
462
319
        try:
463
320
            session.handshake()
464
321
        except gnutls.errors.GNUTLSError, error:
465
 
            logger.warning(u"Handshake failed: %s", error)
 
322
            if debug:
 
323
                sys.stderr.write(u"Handshake failed: %s\n" % error)
466
324
            # Do not run session.bye() here: the session is not
467
325
            # established.  Just abandon the request.
468
326
            return
469
327
        try:
470
328
            fpr = fingerprint(peer_certificate(session))
471
329
        except (TypeError, gnutls.errors.GNUTLSError), error:
472
 
            logger.warning(u"Bad certificate: %s", error)
 
330
            if debug:
 
331
                sys.stderr.write(u"Bad certificate: %s\n" % error)
473
332
            session.bye()
474
333
            return
475
 
        logger.debug(u"Fingerprint: %s", fpr)
 
334
        if debug:
 
335
            sys.stderr.write(u"Fingerprint: %s\n" % fpr)
476
336
        client = None
477
 
        for c in self.server.clients:
 
337
        for c in clients:
478
338
            if c.fingerprint == fpr:
479
339
                client = c
480
340
                break
481
 
        if not client:
482
 
            logger.warning(u"Client not found for fingerprint: %s",
483
 
                           fpr)
484
 
            session.bye()
485
 
            return
486
341
        # Have to check if client.still_valid(), since it is possible
487
342
        # that the client timed out while establishing the GnuTLS
488
343
        # session.
489
 
        if not client.still_valid():
490
 
            logger.warning(u"Client %(name)s is invalid",
491
 
                           vars(client))
 
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)
492
352
            session.bye()
493
353
            return
494
354
        sent_size = 0
495
355
        while sent_size < len(client.secret):
496
356
            sent = session.send(client.secret[sent_size:])
497
 
            logger.debug(u"Sent: %d, remaining: %d",
498
 
                         sent, len(client.secret)
499
 
                         - (sent_size + sent))
 
357
            if debug:
 
358
                sys.stderr.write(u"Sent: %d, remaining: %d\n"
 
359
                                 % (sent, len(client.secret)
 
360
                                    - (sent_size + sent)))
500
361
            sent_size += sent
501
362
        session.bye()
502
363
 
504
365
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
505
366
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
506
367
    Attributes:
507
 
        settings:       Server settings
 
368
        options:        Command line options
508
369
        clients:        Set() of Client objects
509
370
    """
510
371
    address_family = socket.AF_INET6
511
372
    def __init__(self, *args, **kwargs):
512
 
        if "settings" in kwargs:
513
 
            self.settings = kwargs["settings"]
514
 
            del kwargs["settings"]
 
373
        if "options" in kwargs:
 
374
            self.options = kwargs["options"]
 
375
            del kwargs["options"]
515
376
        if "clients" in kwargs:
516
377
            self.clients = kwargs["clients"]
517
378
            del kwargs["clients"]
520
381
        """This overrides the normal server_bind() function
521
382
        to bind to an interface if one was specified, and also NOT to
522
383
        bind to an address or port if they were not specified."""
523
 
        if self.settings["interface"]:
524
 
            # 25 is from /usr/include/asm-i486/socket.h
525
 
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
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
526
388
            try:
527
389
                self.socket.setsockopt(socket.SOL_SOCKET,
528
 
                                       SO_BINDTODEVICE,
529
 
                                       self.settings["interface"])
 
390
                                       socket.SO_BINDTODEVICE,
 
391
                                       self.options.interface)
530
392
            except socket.error, error:
531
393
                if error[0] == errno.EPERM:
532
 
                    logger.error(u"No permission to"
533
 
                                 u" bind to interface %s",
534
 
                                 self.settings["interface"])
 
394
                    sys.stderr.write(u"Warning: No permission to" \
 
395
                                     u" bind to interface %s\n"
 
396
                                     % self.options.interface)
535
397
                else:
536
398
                    raise error
537
399
        # Only bind(2) the socket if we really need to.
580
442
    return delta
581
443
 
582
444
 
 
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
 
583
479
def server_state_changed(state):
584
 
    """Derived from the Avahi example code"""
 
480
    """From the Avahi server example code"""
585
481
    if state == avahi.SERVER_COLLISION:
586
 
        logger.error(u"Server name collision")
587
 
        service.remove()
 
482
        sys.stderr.write(u"WARNING: Server name collision\n")
 
483
        remove_service()
588
484
    elif state == avahi.SERVER_RUNNING:
589
 
        service.add()
 
485
        add_service()
590
486
 
591
487
 
592
488
def entry_group_state_changed(state, error):
593
 
    """Derived from the Avahi example code"""
594
 
    logger.debug(u"state change: %i", state)
 
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)
595
494
    
596
495
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
597
 
        logger.debug(u"Service established.")
 
496
        if debug:
 
497
            sys.stderr.write(u"Service established.\n")
598
498
    elif state == avahi.ENTRY_GROUP_COLLISION:
599
 
        logger.warning(u"Service name collision.")
600
 
        service.rename()
 
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()
601
513
    elif state == avahi.ENTRY_GROUP_FAILURE:
602
 
        logger.critical(u"Error in group state changed %s",
603
 
                        unicode(error))
604
 
        raise AvahiGroupError("State changed: %s", str(error))
 
514
        sys.stderr.write(u"Error in group state changed %s\n"
 
515
                         % unicode(error))
 
516
        main_loop.quit()
 
517
        return
 
518
 
605
519
 
606
520
def if_nametoindex(interface):
607
 
    """Call the C function if_nametoindex(), or equivalent"""
608
 
    global if_nametoindex
 
521
    """Call the C function if_nametoindex()"""
609
522
    try:
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
 
523
        libc = ctypes.cdll.LoadLibrary("libc.so.6")
 
524
        return libc.if_nametoindex(interface)
614
525
    except (OSError, AttributeError):
615
526
        if "struct" not in sys.modules:
616
527
            import struct
617
528
        if "fcntl" not in sys.modules:
618
529
            import fcntl
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
 
    
 
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__':
656
540
    parser = OptionParser()
657
541
    parser.add_option("-i", "--interface", type="string",
658
 
                      metavar="IF", help="Bind to interface IF")
659
 
    parser.add_option("-a", "--address", type="string",
660
 
                      help="Address to listen for requests on")
661
 
    parser.add_option("-p", "--port", type="int",
 
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,
662
557
                      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")
663
564
    parser.add_option("--check", action="store_true", default=False,
664
565
                      help="Run self-test")
665
566
    parser.add_option("--debug", action="store_true", default=False,
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")
 
567
                      help="Debug mode")
676
568
    (options, args) = parser.parse_args()
677
569
    
678
570
    if options.check:
680
572
        doctest.testmod()
681
573
        sys.exit()
682
574
    
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
 
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
734
592
    DBusGMainLoop(set_as_default=True )
735
593
    main_loop = gobject.MainLoop()
736
594
    bus = dbus.SystemBus()
739
597
            avahi.DBUS_INTERFACE_SERVER )
740
598
    # End of Avahi example code
741
599
    
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
 
600
    debug = options.debug
751
601
    
752
602
    clients = Set()
753
603
    def remove_from_clients(client):
754
604
        clients.remove(client)
755
605
        if not clients:
756
 
            logger.critical(u"No clients left, exiting")
757
 
            sys.exit()
 
606
            if debug:
 
607
                sys.stderr.write(u"No clients left, exiting\n")
 
608
            main_loop.quit()
758
609
    
759
 
    clients.update(Set(Client(name = section,
 
610
    clients.update(Set(Client(name=section, options=options,
760
611
                              stop_hook = remove_from_clients,
761
 
                              config
762
 
                              = dict(client_config.items(section)))
 
612
                              **(dict(client_config\
 
613
                                      .items(section))))
763
614
                       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
 
    
789
615
    for client in clients:
790
616
        client.start()
791
617
    
792
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
793
 
                                 server_settings["port"]),
 
618
    tcp_server = IPv6_TCPServer((None, options.port),
794
619
                                tcp_handler,
795
 
                                settings=server_settings,
 
620
                                options=options,
796
621
                                clients=clients)
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
 
    
 
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)
804
639
    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
821
640
        main_loop.run()
822
 
    except AvahiError, error:
823
 
        logger.critical(u"AvahiError: %s" + unicode(error))
824
 
        sys.exit(1)
825
641
    except KeyboardInterrupt:
826
 
        if debug:
827
 
            print
 
642
        print
 
643
    
 
644
    # Cleanup here
828
645
 
829
 
if __name__ == '__main__':
830
 
    main()
 
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()