/mandos/trunk

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

« back to all changes in this revision

Viewing changes to server.py

  • Committer: Björn Påhlsson
  • Date: 2008-07-20 02:52:20 UTC
  • Revision ID: belorn@braxen-20080720025220-r5u0388uy9iu23h6
Added following support:
Pluginbased client handler
rewritten Mandos client
       Avahi instead of udp server discovery
       openpgp encrypted key support
Passprompt stand alone application for direct console input
Added logging for Mandos server

Show diffs side-by-side

added added

removed removed

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