/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

Added all sections needed for mandos-client manual page

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