/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-10 17:52:54 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080810175254-pxjzwws523ji49n7
* Makefile (DOCBOOKTOMAN): Do not generate AUTHORS section.

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