/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-09 15:56:13 UTC
  • mfrom: (24.1.29 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080809155613-pm1o10yh44nafc0g
Merge.

Show diffs side-by-side

added added

removed removed

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