/mandos/release

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

« back to all changes in this revision

Viewing changes to server.py

  • Committer: Teddy Hogeborn
  • Date: 2008-07-20 06:33:48 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080720063348-jscgy5p0itrgvlo8
* mandos-clients.conf ([foo]): Uncommented.
  ([foo]/secret): New.
  ([foo]/secfile): Commented out.
  ([foo]/checker): Changed to "fping -q -- %%(fqdn)s".
  ([foo]/timeout): New.

* server.py: New modeline for Python and Emacs.  Set a logging format.
  (Client.__init__): Bug fix: Choose either the value from the options
                     object or pass the argument through string_to_delta
                     for both "timeout" and "interval".
  (Client.checker_callback): Bug fix: Do not log spurious "Checker for
                             <foo> failed" messages.
  (Client.start_checker): Moved "Starting checker" log message down to
                          just before actually starting the subprocess.
                          Do not redirect the subprocesses' stdout to a
                          pipe.
  (peer_certificate, fingerprint): Added docstrings.
  (entry_group_state_changed): Call "killme()" instead of
                               "main_loop.quit()".
  (daemon, killme): New functions.
  (exitstatus, main_loop_started): New global variables.
  (__main__): Removed the "--cert", "--key", "--ca", and "--crl"
              options.  Removed the sleep command from the default
              checker.  Add a console logger in debug mode.  Call
              "killme()" instead of "main_loop.quit()" when there are no
              more clients.  Call "daemon()" if not in debug mode.
              Register "cleanup()" to run at exit.  Ignore some
              signals.  Catch DBusException to detect another running
              server and exit cleanly.  Exit with "exitstatus".
  (cleanup): New function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
server.py
1
1
#!/usr/bin/python
2
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
3
 
32
4
from __future__ import division
33
5
 
52
24
import subprocess
53
25
import atexit
54
26
import stat
55
 
import logging
56
 
import logging.handlers
57
27
 
58
28
import dbus
59
29
import gobject
61
31
from dbus.mainloop.glib import DBusGMainLoop
62
32
import ctypes
63
33
 
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.
74
 
 
 
34
import logging
 
35
import logging.handlers
75
36
 
76
37
logger = logging.Logger('mandos')
77
38
syslogger = logging.handlers.SysLogHandler\
81
42
logger.addHandler(syslogger)
82
43
del syslogger
83
44
 
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
 
45
# This variable is used to optionally bind to a specified interface.
 
46
# It is a global variable to fit in with the other variables from the
 
47
# Avahi server example code.
 
48
serviceInterface = avahi.IF_UNSPEC
 
49
# From the Avahi server example code:
 
50
serviceName = "Mandos"
 
51
serviceType = "_mandos._tcp" # http://www.dns-sd.org/ServiceTypes.html
 
52
servicePort = None                      # Not known at startup
 
53
serviceTXT = []                         # TXT record for the service
 
54
domain = ""                  # Domain to publish on, default to .local
 
55
host = ""          # Host to publish records for, default to localhost
 
56
group = None #our entry group
 
57
rename_count = 12       # Counter so we only rename after collisions a
 
58
                        # sensible number of times
168
59
# End of Avahi example code
169
60
 
170
61
 
176
67
                 uniquely identify the client
177
68
    secret:    bytestring; sent verbatim (over TLS) to client
178
69
    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
 
70
    created:   datetime.datetime()
 
71
    last_seen: datetime.datetime() or None if not yet seen
 
72
    timeout:   datetime.timedelta(); How long from last_seen until
 
73
                                     this client is invalid
183
74
    interval:  datetime.timedelta(); How often to start a new checker
184
75
    stop_hook: If set, called by stop() as stop_hook(self)
185
76
    checker:   subprocess.Popen(); a running checker process used
186
77
                                   to see if the client lives.
187
 
                                   'None' if no process is running.
 
78
                                   Is None if no process is running.
188
79
    checker_initiator_tag: a gobject event source tag, or None
189
80
    stop_initiator_tag:    - '' -
190
81
    checker_callback_tag:  - '' -
191
82
    checker_command: string; External command which is run to check if
192
 
                     client lives.  %() expansions are done at
 
83
                     client lives.  %()s expansions are done at
193
84
                     runtime with vars(self) as dict, so that for
194
85
                     instance %(name)s can be used in the command.
195
86
    Private attibutes:
196
87
    _timeout: Real variable for 'timeout'
197
88
    _interval: Real variable for 'interval'
198
 
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
89
    _timeout_milliseconds: Used by gobject.timeout_add()
199
90
    _interval_milliseconds: - '' -
200
91
    """
201
92
    def _set_timeout(self, timeout):
221
112
    interval = property(lambda self: self._interval,
222
113
                        _set_interval)
223
114
    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.."""
 
115
    def __init__(self, name=None, options=None, stop_hook=None,
 
116
                 fingerprint=None, secret=None, secfile=None,
 
117
                 fqdn=None, timeout=None, interval=-1, checker=None):
229
118
        self.name = name
230
 
        logger.debug(u"Creating client %r", self.name)
231
119
        # Uppercase and remove spaces from fingerprint
232
120
        # for later comparison purposes with return value of
233
121
        # the fingerprint() function
234
122
        self.fingerprint = fingerprint.upper().replace(u" ", u"")
235
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
236
123
        if secret:
237
124
            self.secret = secret.decode(u"base64")
238
125
        elif secfile:
240
127
            self.secret = sf.read()
241
128
            sf.close()
242
129
        else:
243
 
            raise TypeError(u"No secret or secfile for client %s"
244
 
                            % self.name)
245
 
        self.fqdn = fqdn
 
130
            raise RuntimeError(u"No secret or secfile for client %s"
 
131
                               % self.name)
 
132
        self.fqdn = fqdn                # string
246
133
        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)
 
134
        self.last_seen = None
 
135
        if timeout is None:
 
136
            self.timeout = options.timeout
 
137
        else:
 
138
            self.timeout = string_to_delta(timeout)
 
139
        if interval == -1:
 
140
            self.interval = options.interval
 
141
        else:
 
142
            self.interval = string_to_delta(interval)
250
143
        self.stop_hook = stop_hook
251
144
        self.checker = None
252
145
        self.checker_initiator_tag = None
254
147
        self.checker_callback_tag = None
255
148
        self.check_command = checker
256
149
    def start(self):
257
 
        """Start this client's checker and timeout hooks"""
 
150
        """Start this clients checker and timeout hooks"""
258
151
        # Schedule a new checker to be started an 'interval' from now,
259
152
        # and every interval from then on.
260
153
        self.checker_initiator_tag = gobject.timeout_add\
268
161
                                   self.stop)
269
162
    def stop(self):
270
163
        """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):
 
164
        The possibility that this client might be restarted is left
 
165
        open, but not currently used."""
 
166
        logger.debug(u"Stopping client %s", self.name)
 
167
        self.secret = None
 
168
        if self.stop_initiator_tag:
280
169
            gobject.source_remove(self.stop_initiator_tag)
281
170
            self.stop_initiator_tag = None
282
 
        if getattr(self, "checker_initiator_tag", False):
 
171
        if self.checker_initiator_tag:
283
172
            gobject.source_remove(self.checker_initiator_tag)
284
173
            self.checker_initiator_tag = None
285
174
        self.stop_checker()
288
177
        # Do not run this again if called by a gobject.timeout_add
289
178
        return False
290
179
    def __del__(self):
291
 
        self.stop_hook = None
292
 
        self.stop()
 
180
        # Some code duplication here and in stop()
 
181
        if hasattr(self, "stop_initiator_tag") \
 
182
               and self.stop_initiator_tag:
 
183
            gobject.source_remove(self.stop_initiator_tag)
 
184
            self.stop_initiator_tag = None
 
185
        if hasattr(self, "checker_initiator_tag") \
 
186
               and self.checker_initiator_tag:
 
187
            gobject.source_remove(self.checker_initiator_tag)
 
188
            self.checker_initiator_tag = None
 
189
        self.stop_checker()
293
190
    def checker_callback(self, pid, condition):
294
191
        """The checker has completed, so take appropriate actions."""
295
192
        now = datetime.datetime.now()
296
 
        self.checker_callback_tag = None
297
 
        self.checker = None
298
193
        if os.WIFEXITED(condition) \
299
194
               and (os.WEXITSTATUS(condition) == 0):
300
195
            logger.debug(u"Checker for %(name)s succeeded",
301
196
                         vars(self))
302
 
            self.last_checked_ok = now
 
197
            self.last_seen = now
303
198
            gobject.source_remove(self.stop_initiator_tag)
304
199
            self.stop_initiator_tag = gobject.timeout_add\
305
200
                                      (self._timeout_milliseconds,
310
205
        else:
311
206
            logger.debug(u"Checker for %(name)s failed",
312
207
                         vars(self))
 
208
            self.checker = None
 
209
        self.checker_callback_tag = None
313
210
    def start_checker(self):
314
211
        """Start a new checker subprocess if one is not running.
315
212
        If a checker already exists, leave it running and do
316
213
        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
214
        if self.checker is None:
326
215
            try:
327
 
                # In case check_command has exactly one % operator
328
216
                command = self.check_command % self.fqdn
329
217
            except TypeError:
330
 
                # Escape attributes for the shell
331
218
                escaped_attrs = dict((key, re.escape(str(val)))
332
219
                                     for key, val in
333
220
                                     vars(self).iteritems())
334
221
                try:
335
222
                    command = self.check_command % escaped_attrs
336
223
                except TypeError, error:
337
 
                    logger.error(u'Could not format string "%s":'
338
 
                                 u' %s', self.check_command, error)
 
224
                    logger.critical(u'Could not format string "%s":'
 
225
                                    u' %s', self.check_command, error)
339
226
                    return True # Try again later
340
227
            try:
341
228
                logger.debug(u"Starting checker %r for %s",
342
229
                             command, self.name)
343
 
                self.checker = subprocess.Popen(command,
344
 
                                                close_fds=True,
345
 
                                                shell=True, cwd="/")
 
230
                self.checker = subprocess.\
 
231
                               Popen(command,
 
232
                                     close_fds=True, shell=True,
 
233
                                     cwd="/")
346
234
                self.checker_callback_tag = gobject.child_watch_add\
347
235
                                            (self.checker.pid,
348
236
                                             self.checker_callback)
353
241
        return True
354
242
    def stop_checker(self):
355
243
        """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:
 
244
        if not hasattr(self, "checker") or self.checker is None:
360
245
            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
 
246
        gobject.source_remove(self.checker_callback_tag)
 
247
        self.checker_callback_tag = None
 
248
        os.kill(self.checker.pid, signal.SIGTERM)
 
249
        if self.checker.poll() is None:
 
250
            os.kill(self.checker.pid, signal.SIGKILL)
370
251
        self.checker = None
371
 
    def still_valid(self):
 
252
    def still_valid(self, now=None):
372
253
        """Has the timeout not yet passed for this client?"""
373
 
        now = datetime.datetime.now()
374
 
        if self.last_checked_ok is None:
 
254
        if now is None:
 
255
            now = datetime.datetime.now()
 
256
        if self.last_seen is None:
375
257
            return now < (self.created + self.timeout)
376
258
        else:
377
 
            return now < (self.last_checked_ok + self.timeout)
 
259
            return now < (self.last_seen + self.timeout)
378
260
 
379
261
 
380
262
def peer_certificate(session):
381
 
    "Return the peer's OpenPGP certificate as a bytestring"
 
263
    "Return an OpenPGP data packet string for the peer's certificate"
382
264
    # If not an OpenPGP certificate...
383
265
    if gnutls.library.functions.gnutls_certificate_type_get\
384
266
            (session._c_object) \
395
277
 
396
278
 
397
279
def fingerprint(openpgp):
398
 
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
280
    "Convert an OpenPGP data string to a hexdigit fingerprint string"
399
281
    # New empty GnuTLS certificate
400
282
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
401
283
    gnutls.library.functions.gnutls_openpgp_crt_init\
433
315
    def handle(self):
434
316
        logger.debug(u"TCP connection from: %s",
435
317
                     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.
 
318
        session = gnutls.connection.ClientSession(self.request,
 
319
                                                  gnutls.connection.\
 
320
                                                  X509Credentials())
442
321
        
443
322
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
444
323
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
445
324
        #                "+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"]
 
325
        priority = "SECURE256"
 
326
        
450
327
        gnutls.library.functions.gnutls_priority_set_direct\
451
328
            (session._c_object, priority, None);
452
329
        
465
342
            return
466
343
        logger.debug(u"Fingerprint: %s", fpr)
467
344
        client = None
468
 
        for c in self.server.clients:
 
345
        for c in clients:
469
346
            if c.fingerprint == fpr:
470
347
                client = c
471
348
                break
472
 
        if not client:
473
 
            logger.debug(u"Client not found for fingerprint: %s", fpr)
474
 
            session.bye()
475
 
            return
476
349
        # Have to check if client.still_valid(), since it is possible
477
350
        # that the client timed out while establishing the GnuTLS
478
351
        # session.
479
 
        if not client.still_valid():
480
 
            logger.debug(u"Client %(name)s is invalid", vars(client))
 
352
        if (not client) or (not client.still_valid()):
 
353
            if client:
 
354
                logger.debug(u"Client %(name)s is invalid",
 
355
                             vars(client))
 
356
            else:
 
357
                logger.debug(u"Client not found for fingerprint: %s",
 
358
                             fpr)
481
359
            session.bye()
482
360
            return
483
361
        sent_size = 0
493
371
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
494
372
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
495
373
    Attributes:
496
 
        settings:       Server settings
 
374
        options:        Command line options
497
375
        clients:        Set() of Client objects
498
376
    """
499
377
    address_family = socket.AF_INET6
500
378
    def __init__(self, *args, **kwargs):
501
 
        if "settings" in kwargs:
502
 
            self.settings = kwargs["settings"]
503
 
            del kwargs["settings"]
 
379
        if "options" in kwargs:
 
380
            self.options = kwargs["options"]
 
381
            del kwargs["options"]
504
382
        if "clients" in kwargs:
505
383
            self.clients = kwargs["clients"]
506
384
            del kwargs["clients"]
509
387
        """This overrides the normal server_bind() function
510
388
        to bind to an interface if one was specified, and also NOT to
511
389
        bind to an address or port if they were not specified."""
512
 
        if self.settings["interface"]:
513
 
            # 25 is from /usr/include/asm-i486/socket.h
514
 
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
390
        if self.options.interface:
 
391
            if not hasattr(socket, "SO_BINDTODEVICE"):
 
392
                # From /usr/include/asm-i486/socket.h
 
393
                socket.SO_BINDTODEVICE = 25
515
394
            try:
516
395
                self.socket.setsockopt(socket.SOL_SOCKET,
517
 
                                       SO_BINDTODEVICE,
518
 
                                       self.settings["interface"])
 
396
                                       socket.SO_BINDTODEVICE,
 
397
                                       self.options.interface)
519
398
            except socket.error, error:
520
399
                if error[0] == errno.EPERM:
521
400
                    logger.warning(u"No permission to"
522
401
                                   u" bind to interface %s",
523
 
                                   self.settings["interface"])
 
402
                                   self.options.interface)
524
403
                else:
525
404
                    raise error
526
405
        # Only bind(2) the socket if we really need to.
569
448
    return delta
570
449
 
571
450
 
 
451
def add_service():
 
452
    """From the Avahi server example code"""
 
453
    global group, serviceName, serviceType, servicePort, serviceTXT, \
 
454
           domain, host
 
455
    if group is None:
 
456
        group = dbus.Interface(
 
457
                bus.get_object( avahi.DBUS_NAME,
 
458
                                server.EntryGroupNew()),
 
459
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
460
        group.connect_to_signal('StateChanged',
 
461
                                entry_group_state_changed)
 
462
    logger.debug(u"Adding service '%s' of type '%s' ...",
 
463
                 serviceName, serviceType)
 
464
    
 
465
    group.AddService(
 
466
            serviceInterface,           # interface
 
467
            avahi.PROTO_INET6,          # protocol
 
468
            dbus.UInt32(0),             # flags
 
469
            serviceName, serviceType,
 
470
            domain, host,
 
471
            dbus.UInt16(servicePort),
 
472
            avahi.string_array_to_txt_array(serviceTXT))
 
473
    group.Commit()
 
474
 
 
475
 
 
476
def remove_service():
 
477
    """From the Avahi server example code"""
 
478
    global group
 
479
    
 
480
    if not group is None:
 
481
        group.Reset()
 
482
 
 
483
 
572
484
def server_state_changed(state):
573
 
    """Derived from the Avahi example code"""
 
485
    """From the Avahi server example code"""
574
486
    if state == avahi.SERVER_COLLISION:
575
487
        logger.warning(u"Server name collision")
576
 
        service.remove()
 
488
        remove_service()
577
489
    elif state == avahi.SERVER_RUNNING:
578
 
        service.add()
 
490
        add_service()
579
491
 
580
492
 
581
493
def entry_group_state_changed(state, error):
582
 
    """Derived from the Avahi example code"""
 
494
    """From the Avahi server example code"""
 
495
    global serviceName, server, rename_count
 
496
    
583
497
    logger.debug(u"state change: %i", state)
584
498
    
585
499
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
586
500
        logger.debug(u"Service established.")
587
501
    elif state == avahi.ENTRY_GROUP_COLLISION:
588
 
        logger.warning(u"Service name collision.")
589
 
        service.rename()
 
502
        
 
503
        rename_count = rename_count - 1
 
504
        if rename_count > 0:
 
505
            name = server.GetAlternativeServiceName(name)
 
506
            logger.warning(u"Service name collision, "
 
507
                           u"changing name to '%s' ...", name)
 
508
            remove_service()
 
509
            add_service()
 
510
            
 
511
        else:
 
512
            logger.error(u"No suitable service name found after %i"
 
513
                         u" retries, exiting.", n_rename)
 
514
            killme(1)
590
515
    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)
 
516
        logger.error(u"Error in group state changed %s",
 
517
                     unicode(error))
 
518
        killme(1)
 
519
 
 
520
 
 
521
def if_nametoindex(interface):
 
522
    """Call the C function if_nametoindex()"""
599
523
    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
 
524
        libc = ctypes.cdll.LoadLibrary("libc.so.6")
 
525
        return libc.if_nametoindex(interface)
611
526
    except (OSError, AttributeError):
612
527
        if "struct" not in sys.modules:
613
528
            import struct
614
529
        if "fcntl" not in sys.modules:
615
530
            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)
 
531
        SIOCGIFINDEX = 0x8933      # From /usr/include/linux/sockios.h
 
532
        s = socket.socket()
 
533
        ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
534
                            struct.pack("16s16x", interface))
 
535
        s.close()
 
536
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
537
        return interface_index
627
538
 
628
539
 
629
540
def daemon(nochdir, noclose):
636
547
        os.chdir("/")
637
548
    if not noclose:
638
549
        # Close all standard open file descriptors
639
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
550
        null = os.open("/dev/null", os.O_NOCTTY | os.O_RDWR)
640
551
        if not stat.S_ISCHR(os.fstat(null).st_mode):
641
552
            raise OSError(errno.ENODEV,
642
553
                          "/dev/null not a character device")
647
558
            os.close(null)
648
559
 
649
560
 
650
 
def main():
651
 
    global main_loop_started
 
561
def killme(status = 0):
 
562
    logger.debug("Stopping server with exit status %d", status)
 
563
    exitstatus = status
 
564
    if main_loop_started:
 
565
        main_loop.quit()
 
566
    else:
 
567
        sys.exit(status)
 
568
 
 
569
 
 
570
if __name__ == '__main__':
 
571
    exitstatus = 0
652
572
    main_loop_started = False
653
 
    
654
573
    parser = OptionParser()
655
574
    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",
 
575
                      default=None, metavar="IF",
 
576
                      help="Bind to interface IF")
 
577
    parser.add_option("-p", "--port", type="int", default=None,
660
578
                      help="Port number to receive requests on")
 
579
    parser.add_option("--timeout", type="string", # Parsed later
 
580
                      default="1h",
 
581
                      help="Amount of downtime allowed for clients")
 
582
    parser.add_option("--interval", type="string", # Parsed later
 
583
                      default="5m",
 
584
                      help="How often to check that a client is up")
661
585
    parser.add_option("--check", action="store_true", default=False,
662
586
                      help="Run self-test")
663
587
    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")
 
588
                      help="Debug mode")
674
589
    (options, args) = parser.parse_args()
675
590
    
676
591
    if options.check:
678
593
        doctest.testmod()
679
594
        sys.exit()
680
595
    
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
 
    
703
 
    # Override the settings from the config file with command line
704
 
    # options, if set.
705
 
    for option in ("interface", "address", "port", "debug",
706
 
                   "priority", "servicename", "configdir"):
707
 
        value = getattr(options, option)
708
 
        if value is not None:
709
 
            server_settings[option] = value
710
 
    del options
711
 
    # Now we have our good server settings in "server_settings"
712
 
    
713
 
    # Parse config file with clients
714
 
    client_defaults = { "timeout": "1h",
715
 
                        "interval": "5m",
716
 
                        "checker": "fping -q -- %%(fqdn)s",
717
 
                        }
718
 
    client_config = ConfigParser.SafeConfigParser(client_defaults)
719
 
    client_config.read(os.path.join(server_settings["configdir"],
720
 
                                    "clients.conf"))
721
 
    
722
 
    global service
723
 
    service = AvahiService(name = server_settings["servicename"],
724
 
                           type = "_mandos._tcp", );
725
 
    if server_settings["interface"]:
726
 
        service.interface = if_nametoindex(server_settings["interface"])
727
 
    
728
 
    global main_loop
729
 
    global bus
730
 
    global server
731
 
    # From the Avahi example code
 
596
    # Parse the time arguments
 
597
    try:
 
598
        options.timeout = string_to_delta(options.timeout)
 
599
    except ValueError:
 
600
        parser.error("option --timeout: Unparseable time")
 
601
    try:
 
602
        options.interval = string_to_delta(options.interval)
 
603
    except ValueError:
 
604
        parser.error("option --interval: Unparseable time")
 
605
    
 
606
    # Parse config file
 
607
    defaults = { "checker": "fping -q -- %%(fqdn)s" }
 
608
    client_config = ConfigParser.SafeConfigParser(defaults)
 
609
    #client_config.readfp(open("secrets.conf"), "secrets.conf")
 
610
    client_config.read("mandos-clients.conf")
 
611
    
 
612
    # From the Avahi server example code
732
613
    DBusGMainLoop(set_as_default=True )
733
614
    main_loop = gobject.MainLoop()
734
615
    bus = dbus.SystemBus()
737
618
            avahi.DBUS_INTERFACE_SERVER )
738
619
    # End of Avahi example code
739
620
    
740
 
    debug = server_settings["debug"]
 
621
    debug = options.debug
741
622
    
742
623
    if debug:
743
624
        console = logging.StreamHandler()
752
633
        clients.remove(client)
753
634
        if not clients:
754
635
            logger.debug(u"No clients left, exiting")
755
 
            sys.exit()
 
636
            killme()
756
637
    
757
 
    clients.update(Set(Client(name=section,
 
638
    clients.update(Set(Client(name=section, options=options,
758
639
                              stop_hook = remove_from_clients,
759
640
                              **(dict(client_config\
760
641
                                      .items(section))))
766
647
    def cleanup():
767
648
        "Cleanup function; run on exit"
768
649
        global group
769
 
        # From the Avahi example code
 
650
        # From the Avahi server example code
770
651
        if not group is None:
771
652
            group.Free()
772
653
            group = None
773
654
        # End of Avahi example code
774
655
        
775
 
        while clients:
776
 
            client = clients.pop()
 
656
        for client in clients:
777
657
            client.stop_hook = None
778
658
            client.stop()
779
659
    
781
661
    
782
662
    if not debug:
783
663
        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())
 
664
    signal.signal(signal.SIGHUP, lambda signum, frame: killme())
 
665
    signal.signal(signal.SIGTERM, lambda signum, frame: killme())
786
666
    
787
667
    for client in clients:
788
668
        client.start()
789
669
    
790
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
791
 
                                 server_settings["port"]),
 
670
    tcp_server = IPv6_TCPServer((None, options.port),
792
671
                                tcp_handler,
793
 
                                settings=server_settings,
 
672
                                options=options,
794
673
                                clients=clients)
795
 
    # Find out what port we got
796
 
    service.port = tcp_server.socket.getsockname()[1]
797
 
    logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
798
 
                 u" scope_id %d" % tcp_server.socket.getsockname())
799
 
    
800
 
    #service.interface = tcp_server.socket.getsockname()[3]
801
 
    
802
 
    try:
803
 
        # From the Avahi example code
804
 
        server.connect_to_signal("StateChanged", server_state_changed)
805
 
        try:
806
 
            server_state_changed(server.GetState())
807
 
        except dbus.exceptions.DBusException, error:
808
 
            logger.critical(u"DBusException: %s", error)
809
 
            sys.exit(1)
810
 
        # End of Avahi example code
811
 
        
812
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
813
 
                             lambda *args, **kwargs:
814
 
                             tcp_server.handle_request\
815
 
                             (*args[2:], **kwargs) or True)
816
 
        
817
 
        logger.debug("Starting main loop")
 
674
    # Find out what random port we got
 
675
    servicePort = tcp_server.socket.getsockname()[1]
 
676
    logger.debug(u"Now listening on port %d", servicePort)
 
677
    
 
678
    if options.interface is not None:
 
679
        serviceInterface = if_nametoindex(options.interface)
 
680
    
 
681
    # From the Avahi server example code
 
682
    server.connect_to_signal("StateChanged", server_state_changed)
 
683
    try:
 
684
        server_state_changed(server.GetState())
 
685
    except dbus.exceptions.DBusException, error:
 
686
        logger.critical(u"DBusException: %s", error)
 
687
        killme(1)
 
688
    # End of Avahi example code
 
689
    
 
690
    gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
691
                         lambda *args, **kwargs:
 
692
                         tcp_server.handle_request(*args[2:],
 
693
                                                   **kwargs) or True)
 
694
    try:
818
695
        main_loop_started = True
819
696
        main_loop.run()
820
 
    except AvahiError, error:
821
 
        logger.critical(u"AvahiError: %s" + unicode(error))
822
 
        sys.exit(1)
823
697
    except KeyboardInterrupt:
824
698
        if debug:
825
699
            print
826
 
 
827
 
if __name__ == '__main__':
828
 
    main()
 
700
    
 
701
    sys.exit(exitstatus)