/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 mandos

  • Committer: Teddy Hogeborn
  • Date: 2008-08-22 00:16:20 UTC
  • mfrom: (24.1.57 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080822001620-vxpn1evy0t0kyvj0
* clients.conf ([DEFAULT]/checker): Update to new default value.

* mandos (Client.start_checker): Bug fix: OSError, not
                                 subprocess.OSError.
  (main): Use "fping -q -- %(host)s" instead of "fping -q --
          %%(host)s" as default value for "checker".  Always redirect
          stdin to be from /dev/null, even if in debug mode.

* mandos-clients.conf.xml (DESCRIPTION): Improved wording and refer to
                                         the EXPANSION section.
  (OPTIONS): Added synopsis and improved wording for "checker",
             "fingerprint", and "secret".  Refer to the RUNTIME
             EXPANSION section for the "checker" option.
  (EXAMPLE): Update to new default value for "checker".

* mandos-keygen (trap): Split lines and add "set +e".

Show diffs side-by-side

added added

removed removed

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