/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: 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:
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 © 2008 Teddy Hogeborn
15
 
# Copyright © 2008 Björn Påhlsson
16
 
17
 
# This program is free software: you can redistribute it and/or modify
18
 
# it under the terms of the GNU General Public License as published by
19
 
# the Free Software Foundation, either version 3 of the License, or
20
 
# (at your option) any later version.
21
 
#
22
 
#     This program is distributed in the hope that it will be useful,
23
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
24
 
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25
 
#     GNU General Public License for more details.
26
 
27
 
# You should have received a copy of the GNU General Public License
28
 
# along with this program.  If not, see
29
 
# <http://www.gnu.org/licenses/>.
30
 
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
32
 
33
2
 
34
 
from __future__ import division, with_statement, absolute_import
 
3
from __future__ import division
35
4
 
36
5
import SocketServer
37
6
import socket
 
7
import select
38
8
from optparse import OptionParser
39
9
import datetime
40
10
import errno
51
21
import signal
52
22
from sets import Set
53
23
import subprocess
54
 
import atexit
55
 
import stat
56
 
import logging
57
 
import logging.handlers
58
 
import pwd
59
 
from contextlib import closing
60
24
 
61
25
import dbus
62
 
import dbus.service
63
26
import gobject
64
27
import avahi
65
28
from dbus.mainloop.glib import DBusGMainLoop
66
29
import ctypes
67
 
import ctypes.util
68
 
 
69
 
version = "1.0.2"
 
30
 
 
31
import logging
 
32
import logging.handlers
 
33
 
 
34
# logghandler.setFormatter(logging.Formatter('%(levelname)s %(message)s')
70
35
 
71
36
logger = logging.Logger('mandos')
72
 
syslogger = (logging.handlers.SysLogHandler
73
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
74
 
              address = "/dev/log"))
75
 
syslogger.setFormatter(logging.Formatter
76
 
                       ('Mandos: %(levelname)s: %(message)s'))
77
 
logger.addHandler(syslogger)
78
 
 
79
 
console = logging.StreamHandler()
80
 
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
81
 
                                       ' %(message)s'))
82
 
logger.addHandler(console)
83
 
 
84
 
class AvahiError(Exception):
85
 
    def __init__(self, value, *args, **kwargs):
86
 
        self.value = value
87
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
88
 
    def __unicode__(self):
89
 
        return unicode(repr(self.value))
90
 
 
91
 
class AvahiServiceError(AvahiError):
92
 
    pass
93
 
 
94
 
class AvahiGroupError(AvahiError):
95
 
    pass
96
 
 
97
 
 
98
 
class AvahiService(object):
99
 
    """An Avahi (Zeroconf) service.
100
 
    Attributes:
101
 
    interface: integer; avahi.IF_UNSPEC or an interface index.
102
 
               Used to optionally bind to the specified interface.
103
 
    name: string; Example: 'Mandos'
104
 
    type: string; Example: '_mandos._tcp'.
105
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
106
 
    port: integer; what port to announce
107
 
    TXT: list of strings; TXT record for the service
108
 
    domain: string; Domain to publish on, default to .local if empty.
109
 
    host: string; Host to publish records for, default is localhost
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
 
                 servicetype = None, port = None, TXT = None,
116
 
                 domain = "", host = "", max_renames = 32768):
117
 
        self.interface = interface
118
 
        self.name = name
119
 
        self.type = servicetype
120
 
        self.port = port
121
 
        self.TXT = TXT if TXT is not None else []
122
 
        self.domain = domain
123
 
        self.host = host
124
 
        self.rename_count = 0
125
 
        self.max_renames = max_renames
126
 
    def rename(self):
127
 
        """Derived from the Avahi example code"""
128
 
        if self.rename_count >= self.max_renames:
129
 
            logger.critical(u"No suitable Zeroconf service name found"
130
 
                            u" after %i retries, exiting.",
131
 
                            self.rename_count)
132
 
            raise AvahiServiceError(u"Too many renames")
133
 
        self.name = server.GetAlternativeServiceName(self.name)
134
 
        logger.info(u"Changing Zeroconf service name to %r ...",
135
 
                    str(self.name))
136
 
        syslogger.setFormatter(logging.Formatter
137
 
                               ('Mandos (%s): %%(levelname)s:'
138
 
                                ' %%(message)s' % self.name))
139
 
        self.remove()
140
 
        self.add()
141
 
        self.rename_count += 1
142
 
    def remove(self):
143
 
        """Derived from the Avahi example code"""
144
 
        if group is not None:
145
 
            group.Reset()
146
 
    def add(self):
147
 
        """Derived from the Avahi example code"""
148
 
        global group
149
 
        if group is None:
150
 
            group = dbus.Interface(bus.get_object
151
 
                                   (avahi.DBUS_NAME,
152
 
                                    server.EntryGroupNew()),
153
 
                                   avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
 
            group.connect_to_signal('StateChanged',
155
 
                                    entry_group_state_changed)
156
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
157
 
                     service.name, service.type)
158
 
        group.AddService(
159
 
                self.interface,         # interface
160
 
                avahi.PROTO_INET6,      # protocol
161
 
                dbus.UInt32(0),         # flags
162
 
                self.name, self.type,
163
 
                self.domain, self.host,
164
 
                dbus.UInt16(self.port),
165
 
                avahi.string_array_to_txt_array(self.TXT))
166
 
        group.Commit()
167
 
 
168
 
# From the Avahi example code:
169
 
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
170
53
# End of Avahi example code
171
54
 
172
55
 
173
 
def _datetime_to_dbus(dt, variant_level=0):
174
 
    """Convert a UTC datetime.datetime() to a D-Bus type."""
175
 
    return dbus.String(dt.isoformat(), variant_level=variant_level)
176
 
 
177
 
 
178
 
class Client(dbus.service.Object):
 
56
class Client(object):
179
57
    """A representation of a client host served by this server.
180
58
    Attributes:
181
 
    name:       string; from the config file, used in log messages
 
59
    name:      string; from the config file, used in log messages
182
60
    fingerprint: string (40 or 32 hexadecimal digits); used to
183
61
                 uniquely identify the client
184
 
    secret:     bytestring; sent verbatim (over TLS) to client
185
 
    host:       string; available for use by the checker command
186
 
    created:    datetime.datetime(); (UTC) object creation
187
 
    last_enabled: datetime.datetime(); (UTC)
188
 
    enabled:    bool()
189
 
    last_checked_ok: datetime.datetime(); (UTC) or None
190
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
191
 
                                      until this client is invalid
192
 
    interval:   datetime.timedelta(); How often to start a new checker
193
 
    disable_hook:  If set, called by disable() as disable_hook(self)
194
 
    checker:    subprocess.Popen(); a running checker process used
195
 
                                    to see if the client lives.
196
 
                                    'None' if no process is running.
 
62
    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
 
68
    interval:  datetime.timedelta(); How often to start a new checker
 
69
    stop_hook: If set, called by stop() as stop_hook(self)
 
70
    checker:   subprocess.Popen(); a running checker process used
 
71
                                   to see if the client lives.
 
72
                                   Is None if no process is running.
197
73
    checker_initiator_tag: a gobject event source tag, or None
198
 
    disable_initiator_tag:    - '' -
 
74
    stop_initiator_tag:    - '' -
199
75
    checker_callback_tag:  - '' -
200
76
    checker_command: string; External command which is run to check if
201
 
                     client lives.  %() expansions are done at
 
77
                     client lives.  %()s expansions are done at
202
78
                     runtime with vars(self) as dict, so that for
203
79
                     instance %(name)s can be used in the command.
204
 
    use_dbus: bool(); Whether to provide D-Bus interface and signals
205
 
    dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
 
80
    Private attibutes:
 
81
    _timeout: Real variable for 'timeout'
 
82
    _interval: Real variable for 'interval'
 
83
    _timeout_milliseconds: Used by gobject.timeout_add()
 
84
    _interval_milliseconds: - '' -
206
85
    """
207
 
    def timeout_milliseconds(self):
208
 
        "Return the 'timeout' attribute in milliseconds"
209
 
        return ((self.timeout.days * 24 * 60 * 60 * 1000)
210
 
                + (self.timeout.seconds * 1000)
211
 
                + (self.timeout.microseconds // 1000))
212
 
    
213
 
    def interval_milliseconds(self):
214
 
        "Return the 'interval' attribute in milliseconds"
215
 
        return ((self.interval.days * 24 * 60 * 60 * 1000)
216
 
                + (self.interval.seconds * 1000)
217
 
                + (self.interval.microseconds // 1000))
218
 
    
219
 
    def __init__(self, name = None, disable_hook=None, config=None,
220
 
                 use_dbus=True):
221
 
        """Note: the 'checker' key in 'config' sets the
222
 
        'checker_command' attribute and *not* the 'checker'
223
 
        attribute."""
 
86
    def _set_timeout(self, timeout):
 
87
        "Setter function for 'timeout' attribute"
 
88
        self._timeout = timeout
 
89
        self._timeout_milliseconds = ((self.timeout.days
 
90
                                       * 24 * 60 * 60 * 1000)
 
91
                                      + (self.timeout.seconds * 1000)
 
92
                                      + (self.timeout.microseconds
 
93
                                         // 1000))
 
94
    timeout = property(lambda self: self._timeout,
 
95
                       _set_timeout)
 
96
    del _set_timeout
 
97
    def _set_interval(self, interval):
 
98
        "Setter function for 'interval' attribute"
 
99
        self._interval = interval
 
100
        self._interval_milliseconds = ((self.interval.days
 
101
                                        * 24 * 60 * 60 * 1000)
 
102
                                       + (self.interval.seconds
 
103
                                          * 1000)
 
104
                                       + (self.interval.microseconds
 
105
                                          // 1000))
 
106
    interval = property(lambda self: self._interval,
 
107
                        _set_interval)
 
108
    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):
224
112
        self.name = name
225
 
        if config is None:
226
 
            config = {}
227
 
        logger.debug(u"Creating client %r", self.name)
228
 
        self.use_dbus = use_dbus
229
 
        if self.use_dbus:
230
 
            self.dbus_object_path = (dbus.ObjectPath
231
 
                                     ("/Mandos/clients/"
232
 
                                      + self.name.replace(".", "_")))
233
 
            dbus.service.Object.__init__(self, bus,
234
 
                                         self.dbus_object_path)
235
 
        # Uppercase and remove spaces from fingerprint for later
236
 
        # comparison purposes with return value from the fingerprint()
237
 
        # function
238
 
        self.fingerprint = (config["fingerprint"].upper()
239
 
                            .replace(u" ", u""))
240
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
241
 
        if "secret" in config:
242
 
            self.secret = config["secret"].decode(u"base64")
243
 
        elif "secfile" in config:
244
 
            with closing(open(os.path.expanduser
245
 
                              (os.path.expandvars
246
 
                               (config["secfile"])))) as secfile:
247
 
                self.secret = secfile.read()
248
 
        else:
249
 
            raise TypeError(u"No secret or secfile for client %s"
250
 
                            % self.name)
251
 
        self.host = config.get("host", "")
252
 
        self.created = datetime.datetime.utcnow()
253
 
        self.enabled = False
254
 
        self.last_enabled = None
255
 
        self.last_checked_ok = None
256
 
        self.timeout = string_to_delta(config["timeout"])
257
 
        self.interval = string_to_delta(config["interval"])
258
 
        self.disable_hook = disable_hook
 
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)
 
121
            self.secret = sf.read()
 
122
            sf.close()
 
123
        else:
 
124
            raise RuntimeError(u"No secret or secfile for client %s"
 
125
                               % self.name)
 
126
        self.fqdn = fqdn                # string
 
127
        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
 
137
        self.stop_hook = stop_hook
259
138
        self.checker = None
260
139
        self.checker_initiator_tag = None
261
 
        self.disable_initiator_tag = None
 
140
        self.stop_initiator_tag = None
262
141
        self.checker_callback_tag = None
263
 
        self.checker_command = config["checker"]
264
 
    
265
 
    def enable(self):
266
 
        """Start this client's checker and timeout hooks"""
267
 
        self.last_enabled = datetime.datetime.utcnow()
 
142
        self.check_command = checker
 
143
    def start(self):
 
144
        """Start this clients checker and timeout hooks"""
268
145
        # Schedule a new checker to be started an 'interval' from now,
269
146
        # and every interval from then on.
270
 
        self.checker_initiator_tag = (gobject.timeout_add
271
 
                                      (self.interval_milliseconds(),
272
 
                                       self.start_checker))
 
147
        self.checker_initiator_tag = gobject.timeout_add\
 
148
                                     (self._interval_milliseconds,
 
149
                                      self.start_checker)
273
150
        # Also start a new checker *right now*.
274
151
        self.start_checker()
275
 
        # Schedule a disable() when 'timeout' has passed
276
 
        self.disable_initiator_tag = (gobject.timeout_add
277
 
                                   (self.timeout_milliseconds(),
278
 
                                    self.disable))
279
 
        self.enabled = True
280
 
        if self.use_dbus:
281
 
            # Emit D-Bus signals
282
 
            self.PropertyChanged(dbus.String(u"enabled"),
283
 
                                 dbus.Boolean(True, variant_level=1))
284
 
            self.PropertyChanged(dbus.String(u"last_enabled"),
285
 
                                 (_datetime_to_dbus(self.last_enabled,
286
 
                                                    variant_level=1)))
287
 
    
288
 
    def disable(self):
289
 
        """Disable this client."""
290
 
        if not getattr(self, "enabled", False):
291
 
            return False
292
 
        logger.info(u"Disabling client %s", self.name)
293
 
        if getattr(self, "disable_initiator_tag", False):
294
 
            gobject.source_remove(self.disable_initiator_tag)
295
 
            self.disable_initiator_tag = None
296
 
        if getattr(self, "checker_initiator_tag", False):
 
152
        # Schedule a stop() when 'timeout' has passed
 
153
        self.stop_initiator_tag = gobject.timeout_add\
 
154
                                  (self._timeout_milliseconds,
 
155
                                   self.stop)
 
156
    def stop(self):
 
157
        """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:
 
163
            gobject.source_remove(self.stop_initiator_tag)
 
164
            self.stop_initiator_tag = None
 
165
        if self.checker_initiator_tag:
297
166
            gobject.source_remove(self.checker_initiator_tag)
298
167
            self.checker_initiator_tag = None
299
168
        self.stop_checker()
300
 
        if self.disable_hook:
301
 
            self.disable_hook(self)
302
 
        self.enabled = False
303
 
        if self.use_dbus:
304
 
            # Emit D-Bus signal
305
 
            self.PropertyChanged(dbus.String(u"enabled"),
306
 
                                 dbus.Boolean(False, variant_level=1))
 
169
        if self.stop_hook:
 
170
            self.stop_hook(self)
307
171
        # Do not run this again if called by a gobject.timeout_add
308
172
        return False
309
 
    
310
173
    def __del__(self):
311
 
        self.disable_hook = None
312
 
        self.disable()
313
 
    
314
 
    def checker_callback(self, pid, condition, command):
 
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()
 
184
    def checker_callback(self, pid, condition):
315
185
        """The checker has completed, so take appropriate actions."""
316
 
        self.checker_callback_tag = None
317
 
        self.checker = None
318
 
        if self.use_dbus:
319
 
            # Emit D-Bus signal
320
 
            self.PropertyChanged(dbus.String(u"checker_running"),
321
 
                                 dbus.Boolean(False, variant_level=1))
322
 
        if (os.WIFEXITED(condition)
323
 
            and (os.WEXITSTATUS(condition) == 0)):
324
 
            logger.info(u"Checker for %(name)s succeeded",
325
 
                        vars(self))
326
 
            if self.use_dbus:
327
 
                # Emit D-Bus signal
328
 
                self.CheckerCompleted(dbus.Boolean(True),
329
 
                                      dbus.UInt16(condition),
330
 
                                      dbus.String(command))
331
 
            self.bump_timeout()
332
 
        elif not os.WIFEXITED(condition):
 
186
        now = datetime.datetime.now()
 
187
        if os.WIFEXITED(condition) \
 
188
               and (os.WEXITSTATUS(condition) == 0):
 
189
            logger.debug(u"Checker for %(name)s succeeded",
 
190
                         vars(self))
 
191
            self.last_seen = now
 
192
            gobject.source_remove(self.stop_initiator_tag)
 
193
            self.stop_initiator_tag = gobject.timeout_add\
 
194
                                      (self._timeout_milliseconds,
 
195
                                       self.stop)
 
196
        if not os.WIFEXITED(condition):
333
197
            logger.warning(u"Checker for %(name)s crashed?",
334
198
                           vars(self))
335
 
            if self.use_dbus:
336
 
                # Emit D-Bus signal
337
 
                self.CheckerCompleted(dbus.Boolean(False),
338
 
                                      dbus.UInt16(condition),
339
 
                                      dbus.String(command))
340
199
        else:
341
 
            logger.info(u"Checker for %(name)s failed",
342
 
                        vars(self))
343
 
            if self.use_dbus:
344
 
                # Emit D-Bus signal
345
 
                self.CheckerCompleted(dbus.Boolean(False),
346
 
                                      dbus.UInt16(condition),
347
 
                                      dbus.String(command))
348
 
    
349
 
    def bump_timeout(self):
350
 
        """Bump up the timeout for this client.
351
 
        This should only be called when the client has been seen,
352
 
        alive and well.
353
 
        """
354
 
        self.last_checked_ok = datetime.datetime.utcnow()
355
 
        gobject.source_remove(self.disable_initiator_tag)
356
 
        self.disable_initiator_tag = (gobject.timeout_add
357
 
                                      (self.timeout_milliseconds(),
358
 
                                       self.disable))
359
 
        if self.use_dbus:
360
 
            # Emit D-Bus signal
361
 
            self.PropertyChanged(
362
 
                dbus.String(u"last_checked_ok"),
363
 
                (_datetime_to_dbus(self.last_checked_ok,
364
 
                                   variant_level=1)))
365
 
    
 
200
            logger.debug(u"Checker for %(name)s failed",
 
201
                         vars(self))
 
202
            self.checker = None
 
203
        self.checker_callback_tag = None
366
204
    def start_checker(self):
367
205
        """Start a new checker subprocess if one is not running.
368
206
        If a checker already exists, leave it running and do
369
207
        nothing."""
370
 
        # The reason for not killing a running checker is that if we
371
 
        # did that, then if a checker (for some reason) started
372
 
        # running slowly and taking more than 'interval' time, the
373
 
        # client would inevitably timeout, since no checker would get
374
 
        # a chance to run to completion.  If we instead leave running
375
 
        # checkers alone, the checker would have to take more time
376
 
        # than 'timeout' for the client to be declared invalid, which
377
 
        # is as it should be.
378
208
        if self.checker is None:
 
209
            logger.debug(u"Starting checker for %s",
 
210
                         self.name)
379
211
            try:
380
 
                # In case checker_command has exactly one % operator
381
 
                command = self.checker_command % self.host
 
212
                command = self.check_command % self.fqdn
382
213
            except TypeError:
383
 
                # Escape attributes for the shell
384
214
                escaped_attrs = dict((key, re.escape(str(val)))
385
215
                                     for key, val in
386
216
                                     vars(self).iteritems())
387
217
                try:
388
 
                    command = self.checker_command % escaped_attrs
 
218
                    command = self.check_command % escaped_attrs
389
219
                except TypeError, error:
390
 
                    logger.error(u'Could not format string "%s":'
391
 
                                 u' %s', self.checker_command, error)
 
220
                    logger.critical(u'Could not format string "%s": %s',
 
221
                                    self.check_command, error)
392
222
                    return True # Try again later
393
223
            try:
394
 
                logger.info(u"Starting checker %r for %s",
395
 
                            command, self.name)
396
 
                # We don't need to redirect stdout and stderr, since
397
 
                # in normal mode, that is already done by daemon(),
398
 
                # and in debug mode we don't want to.  (Stdin is
399
 
                # always replaced by /dev/null.)
400
 
                self.checker = subprocess.Popen(command,
401
 
                                                close_fds=True,
402
 
                                                shell=True, cwd="/")
403
 
                if self.use_dbus:
404
 
                    # Emit D-Bus signal
405
 
                    self.CheckerStarted(command)
406
 
                    self.PropertyChanged(
407
 
                        dbus.String("checker_running"),
408
 
                        dbus.Boolean(True, variant_level=1))
409
 
                self.checker_callback_tag = (gobject.child_watch_add
410
 
                                             (self.checker.pid,
411
 
                                              self.checker_callback,
412
 
                                              data=command))
413
 
            except OSError, error:
 
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)
 
233
            except subprocess.OSError, error:
414
234
                logger.error(u"Failed to start subprocess: %s",
415
235
                             error)
416
236
        # Re-run this periodically if run by gobject.timeout_add
417
237
        return True
418
 
    
419
238
    def stop_checker(self):
420
239
        """Force the checker process, if any, to stop."""
421
 
        if self.checker_callback_tag:
422
 
            gobject.source_remove(self.checker_callback_tag)
423
 
            self.checker_callback_tag = None
424
 
        if getattr(self, "checker", None) is None:
 
240
        if not hasattr(self, "checker") or self.checker is None:
425
241
            return
426
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
427
 
        try:
428
 
            os.kill(self.checker.pid, signal.SIGTERM)
429
 
            #os.sleep(0.5)
430
 
            #if self.checker.poll() is None:
431
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
432
 
        except OSError, error:
433
 
            if error.errno != errno.ESRCH: # No such process
434
 
                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)
435
247
        self.checker = None
436
 
        if self.use_dbus:
437
 
            self.PropertyChanged(dbus.String(u"checker_running"),
438
 
                                 dbus.Boolean(False, variant_level=1))
439
 
    
440
 
    def still_valid(self):
 
248
    def still_valid(self, now=None):
441
249
        """Has the timeout not yet passed for this client?"""
442
 
        if not getattr(self, "enabled", False):
443
 
            return False
444
 
        now = datetime.datetime.utcnow()
445
 
        if self.last_checked_ok is None:
 
250
        if now is None:
 
251
            now = datetime.datetime.now()
 
252
        if self.last_seen is None:
446
253
            return now < (self.created + self.timeout)
447
254
        else:
448
 
            return now < (self.last_checked_ok + self.timeout)
449
 
    
450
 
    ## D-Bus methods & signals
451
 
    _interface = u"org.mandos_system.Mandos.Client"
452
 
    
453
 
    # BumpTimeout - method
454
 
    BumpTimeout = dbus.service.method(_interface)(bump_timeout)
455
 
    BumpTimeout.__name__ = "BumpTimeout"
456
 
    
457
 
    # CheckerCompleted - signal
458
 
    @dbus.service.signal(_interface, signature="bqs")
459
 
    def CheckerCompleted(self, success, condition, command):
460
 
        "D-Bus signal"
461
 
        pass
462
 
    
463
 
    # CheckerStarted - signal
464
 
    @dbus.service.signal(_interface, signature="s")
465
 
    def CheckerStarted(self, command):
466
 
        "D-Bus signal"
467
 
        pass
468
 
    
469
 
    # GetAllProperties - method
470
 
    @dbus.service.method(_interface, out_signature="a{sv}")
471
 
    def GetAllProperties(self):
472
 
        "D-Bus method"
473
 
        return dbus.Dictionary({
474
 
                dbus.String("name"):
475
 
                    dbus.String(self.name, variant_level=1),
476
 
                dbus.String("fingerprint"):
477
 
                    dbus.String(self.fingerprint, variant_level=1),
478
 
                dbus.String("host"):
479
 
                    dbus.String(self.host, variant_level=1),
480
 
                dbus.String("created"):
481
 
                    _datetime_to_dbus(self.created, variant_level=1),
482
 
                dbus.String("last_enabled"):
483
 
                    (_datetime_to_dbus(self.last_enabled,
484
 
                                       variant_level=1)
485
 
                     if self.last_enabled is not None
486
 
                     else dbus.Boolean(False, variant_level=1)),
487
 
                dbus.String("enabled"):
488
 
                    dbus.Boolean(self.enabled, variant_level=1),
489
 
                dbus.String("last_checked_ok"):
490
 
                    (_datetime_to_dbus(self.last_checked_ok,
491
 
                                       variant_level=1)
492
 
                     if self.last_checked_ok is not None
493
 
                     else dbus.Boolean (False, variant_level=1)),
494
 
                dbus.String("timeout"):
495
 
                    dbus.UInt64(self.timeout_milliseconds(),
496
 
                                variant_level=1),
497
 
                dbus.String("interval"):
498
 
                    dbus.UInt64(self.interval_milliseconds(),
499
 
                                variant_level=1),
500
 
                dbus.String("checker"):
501
 
                    dbus.String(self.checker_command,
502
 
                                variant_level=1),
503
 
                dbus.String("checker_running"):
504
 
                    dbus.Boolean(self.checker is not None,
505
 
                                 variant_level=1),
506
 
                }, signature="sv")
507
 
    
508
 
    # IsStillValid - method
509
 
    IsStillValid = (dbus.service.method(_interface, out_signature="b")
510
 
                    (still_valid))
511
 
    IsStillValid.__name__ = "IsStillValid"
512
 
    
513
 
    # PropertyChanged - signal
514
 
    @dbus.service.signal(_interface, signature="sv")
515
 
    def PropertyChanged(self, property, value):
516
 
        "D-Bus signal"
517
 
        pass
518
 
    
519
 
    # SetChecker - method
520
 
    @dbus.service.method(_interface, in_signature="s")
521
 
    def SetChecker(self, checker):
522
 
        "D-Bus setter method"
523
 
        self.checker_command = checker
524
 
        # Emit D-Bus signal
525
 
        self.PropertyChanged(dbus.String(u"checker"),
526
 
                             dbus.String(self.checker_command,
527
 
                                         variant_level=1))
528
 
    
529
 
    # SetHost - method
530
 
    @dbus.service.method(_interface, in_signature="s")
531
 
    def SetHost(self, host):
532
 
        "D-Bus setter method"
533
 
        self.host = host
534
 
        # Emit D-Bus signal
535
 
        self.PropertyChanged(dbus.String(u"host"),
536
 
                             dbus.String(self.host, variant_level=1))
537
 
    
538
 
    # SetInterval - method
539
 
    @dbus.service.method(_interface, in_signature="t")
540
 
    def SetInterval(self, milliseconds):
541
 
        self.interval = datetime.timedelta(0, 0, 0, milliseconds)
542
 
        # Emit D-Bus signal
543
 
        self.PropertyChanged(dbus.String(u"interval"),
544
 
                             (dbus.UInt64(self.interval_milliseconds(),
545
 
                                          variant_level=1)))
546
 
    
547
 
    # SetSecret - method
548
 
    @dbus.service.method(_interface, in_signature="ay",
549
 
                         byte_arrays=True)
550
 
    def SetSecret(self, secret):
551
 
        "D-Bus setter method"
552
 
        self.secret = str(secret)
553
 
    
554
 
    # SetTimeout - method
555
 
    @dbus.service.method(_interface, in_signature="t")
556
 
    def SetTimeout(self, milliseconds):
557
 
        self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
558
 
        # Emit D-Bus signal
559
 
        self.PropertyChanged(dbus.String(u"timeout"),
560
 
                             (dbus.UInt64(self.timeout_milliseconds(),
561
 
                                          variant_level=1)))
562
 
    
563
 
    # Enable - method
564
 
    Enable = dbus.service.method(_interface)(enable)
565
 
    Enable.__name__ = "Enable"
566
 
    
567
 
    # StartChecker - method
568
 
    @dbus.service.method(_interface)
569
 
    def StartChecker(self):
570
 
        "D-Bus method"
571
 
        self.start_checker()
572
 
    
573
 
    # Disable - method
574
 
    @dbus.service.method(_interface)
575
 
    def Disable(self):
576
 
        "D-Bus method"
577
 
        self.disable()
578
 
    
579
 
    # StopChecker - method
580
 
    StopChecker = dbus.service.method(_interface)(stop_checker)
581
 
    StopChecker.__name__ = "StopChecker"
582
 
    
583
 
    del _interface
 
255
            return now < (self.last_seen + self.timeout)
584
256
 
585
257
 
586
258
def peer_certificate(session):
587
 
    "Return the peer's OpenPGP certificate as a bytestring"
588
259
    # If not an OpenPGP certificate...
589
 
    if (gnutls.library.functions
590
 
        .gnutls_certificate_type_get(session._c_object)
591
 
        != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
260
    if gnutls.library.functions.gnutls_certificate_type_get\
 
261
            (session._c_object) \
 
262
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
592
263
        # ...do the normal thing
593
264
        return session.peer_certificate
594
265
    list_size = ctypes.c_uint()
595
 
    cert_list = (gnutls.library.functions
596
 
                 .gnutls_certificate_get_peers
597
 
                 (session._c_object, ctypes.byref(list_size)))
 
266
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
267
        (session._c_object, ctypes.byref(list_size))
598
268
    if list_size.value == 0:
599
269
        return None
600
270
    cert = cert_list[0]
602
272
 
603
273
 
604
274
def fingerprint(openpgp):
605
 
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
606
 
    # New GnuTLS "datum" with the OpenPGP public key
607
 
    datum = (gnutls.library.types
608
 
             .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
609
 
                                         ctypes.POINTER
610
 
                                         (ctypes.c_ubyte)),
611
 
                             ctypes.c_uint(len(openpgp))))
612
275
    # New empty GnuTLS certificate
613
276
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
614
 
    (gnutls.library.functions
615
 
     .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
277
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
278
        (ctypes.byref(crt))
 
279
    # New GnuTLS "datum" with the OpenPGP public key
 
280
    datum = gnutls.library.types.gnutls_datum_t\
 
281
        (ctypes.cast(ctypes.c_char_p(openpgp),
 
282
                     ctypes.POINTER(ctypes.c_ubyte)),
 
283
         ctypes.c_uint(len(openpgp)))
616
284
    # Import the OpenPGP public key into the certificate
617
 
    (gnutls.library.functions
618
 
     .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
619
 
                                gnutls.library.constants
620
 
                                .GNUTLS_OPENPGP_FMT_RAW))
621
 
    # Verify the self signature in the key
622
 
    crtverify = ctypes.c_uint()
623
 
    (gnutls.library.functions
624
 
     .gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
625
 
    if crtverify.value != 0:
626
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
627
 
        raise gnutls.errors.CertificateSecurityError("Verify failed")
 
285
    ret = gnutls.library.functions.gnutls_openpgp_crt_import\
 
286
        (crt,
 
287
         ctypes.byref(datum),
 
288
         gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
628
289
    # New buffer for the fingerprint
629
 
    buf = ctypes.create_string_buffer(20)
630
 
    buf_len = ctypes.c_size_t()
 
290
    buffer = ctypes.create_string_buffer(20)
 
291
    buffer_length = ctypes.c_size_t()
631
292
    # Get the fingerprint from the certificate into the buffer
632
 
    (gnutls.library.functions
633
 
     .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
634
 
                                         ctypes.byref(buf_len)))
 
293
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
294
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
635
295
    # Deinit the certificate
636
296
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
637
297
    # Convert the buffer to a Python bytestring
638
 
    fpr = ctypes.string_at(buf, buf_len.value)
 
298
    fpr = ctypes.string_at(buffer, buffer_length.value)
639
299
    # Convert the bytestring to hexadecimal notation
640
300
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
641
301
    return hex_fpr
642
302
 
643
303
 
644
 
class TCP_handler(SocketServer.BaseRequestHandler, object):
 
304
class tcp_handler(SocketServer.BaseRequestHandler, object):
645
305
    """A TCP request handler class.
646
306
    Instantiated by IPv6_TCPServer for each request to handle it.
647
307
    Note: This will run in its own forked process."""
648
308
    
649
309
    def handle(self):
650
 
        logger.info(u"TCP connection from: %s",
651
 
                    unicode(self.client_address))
652
 
        session = (gnutls.connection
653
 
                   .ClientSession(self.request,
654
 
                                  gnutls.connection
655
 
                                  .X509Credentials()))
656
 
        
657
 
        line = self.request.makefile().readline()
658
 
        logger.debug(u"Protocol version: %r", line)
659
 
        try:
660
 
            if int(line.strip().split()[0]) > 1:
661
 
                raise RuntimeError
662
 
        except (ValueError, IndexError, RuntimeError), error:
663
 
            logger.error(u"Unknown protocol version: %s", error)
664
 
            return
665
 
        
666
 
        # Note: gnutls.connection.X509Credentials is really a generic
667
 
        # GnuTLS certificate credentials object so long as no X.509
668
 
        # keys are added to it.  Therefore, we can use it here despite
669
 
        # using OpenPGP certificates.
 
310
        logger.debug(u"TCP connection from: %s",
 
311
                     unicode(self.client_address))
 
312
        session = gnutls.connection.ClientSession(self.request,
 
313
                                                  gnutls.connection.\
 
314
                                                  X509Credentials())
670
315
        
671
316
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
672
317
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
673
318
        #                "+DHE-DSS"))
674
 
        # Use a fallback default, since this MUST be set.
675
 
        priority = self.server.settings.get("priority", "NORMAL")
676
 
        (gnutls.library.functions
677
 
         .gnutls_priority_set_direct(session._c_object,
678
 
                                     priority, None))
 
319
        priority = "SECURE256"
 
320
        
 
321
        gnutls.library.functions.gnutls_priority_set_direct\
 
322
            (session._c_object, priority, None);
679
323
        
680
324
        try:
681
325
            session.handshake()
682
326
        except gnutls.errors.GNUTLSError, error:
683
 
            logger.warning(u"Handshake failed: %s", error)
 
327
            logger.debug(u"Handshake failed: %s", error)
684
328
            # Do not run session.bye() here: the session is not
685
329
            # established.  Just abandon the request.
686
330
            return
687
331
        try:
688
332
            fpr = fingerprint(peer_certificate(session))
689
333
        except (TypeError, gnutls.errors.GNUTLSError), error:
690
 
            logger.warning(u"Bad certificate: %s", error)
 
334
            logger.debug(u"Bad certificate: %s", error)
691
335
            session.bye()
692
336
            return
693
337
        logger.debug(u"Fingerprint: %s", fpr)
694
 
        for c in self.server.clients:
 
338
        client = None
 
339
        for c in clients:
695
340
            if c.fingerprint == fpr:
696
341
                client = c
697
342
                break
698
 
        else:
699
 
            logger.warning(u"Client not found for fingerprint: %s",
700
 
                           fpr)
701
 
            session.bye()
702
 
            return
703
343
        # Have to check if client.still_valid(), since it is possible
704
344
        # that the client timed out while establishing the GnuTLS
705
345
        # session.
706
 
        if not client.still_valid():
707
 
            logger.warning(u"Client %(name)s is invalid",
708
 
                           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)
709
353
            session.bye()
710
354
            return
711
 
        ## This won't work here, since we're in a fork.
712
 
        # client.bump_timeout()
713
355
        sent_size = 0
714
356
        while sent_size < len(client.secret):
715
357
            sent = session.send(client.secret[sent_size:])
720
362
        session.bye()
721
363
 
722
364
 
723
 
class IPv6_TCPServer(SocketServer.ForkingMixIn,
724
 
                     SocketServer.TCPServer, object):
 
365
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
725
366
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
726
367
    Attributes:
727
 
        settings:       Server settings
 
368
        options:        Command line options
728
369
        clients:        Set() of Client objects
729
 
        enabled:        Boolean; whether this server is activated yet
730
370
    """
731
371
    address_family = socket.AF_INET6
732
372
    def __init__(self, *args, **kwargs):
733
 
        if "settings" in kwargs:
734
 
            self.settings = kwargs["settings"]
735
 
            del kwargs["settings"]
 
373
        if "options" in kwargs:
 
374
            self.options = kwargs["options"]
 
375
            del kwargs["options"]
736
376
        if "clients" in kwargs:
737
377
            self.clients = kwargs["clients"]
738
378
            del kwargs["clients"]
739
 
        self.enabled = False
740
 
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
 
379
        return super(type(self), self).__init__(*args, **kwargs)
741
380
    def server_bind(self):
742
381
        """This overrides the normal server_bind() function
743
382
        to bind to an interface if one was specified, and also NOT to
744
383
        bind to an address or port if they were not specified."""
745
 
        if self.settings["interface"]:
746
 
            # 25 is from /usr/include/asm-i486/socket.h
747
 
            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
748
388
            try:
749
389
                self.socket.setsockopt(socket.SOL_SOCKET,
750
 
                                       SO_BINDTODEVICE,
751
 
                                       self.settings["interface"])
 
390
                                       socket.SO_BINDTODEVICE,
 
391
                                       self.options.interface)
752
392
            except socket.error, error:
753
393
                if error[0] == errno.EPERM:
754
 
                    logger.error(u"No permission to"
755
 
                                 u" bind to interface %s",
756
 
                                 self.settings["interface"])
 
394
                    logger.warning(u"No permission to"
 
395
                                   u" bind to interface %s",
 
396
                                   self.options.interface)
757
397
                else:
758
398
                    raise error
759
399
        # Only bind(2) the socket if we really need to.
762
402
                in6addr_any = "::"
763
403
                self.server_address = (in6addr_any,
764
404
                                       self.server_address[1])
765
 
            elif not self.server_address[1]:
 
405
            elif self.server_address[1] is None:
766
406
                self.server_address = (self.server_address[0],
767
407
                                       0)
768
 
#                 if self.settings["interface"]:
769
 
#                     self.server_address = (self.server_address[0],
770
 
#                                            0, # port
771
 
#                                            0, # flowinfo
772
 
#                                            if_nametoindex
773
 
#                                            (self.settings
774
 
#                                             ["interface"]))
775
 
            return super(IPv6_TCPServer, self).server_bind()
776
 
    def server_activate(self):
777
 
        if self.enabled:
778
 
            return super(IPv6_TCPServer, self).server_activate()
779
 
    def enable(self):
780
 
        self.enabled = True
 
408
            return super(type(self), self).server_bind()
781
409
 
782
410
 
783
411
def string_to_delta(interval):
793
421
    datetime.timedelta(1)
794
422
    >>> string_to_delta(u'1w')
795
423
    datetime.timedelta(7)
796
 
    >>> string_to_delta('5m 30s')
797
 
    datetime.timedelta(0, 330)
798
424
    """
799
 
    timevalue = datetime.timedelta(0)
800
 
    for s in interval.split():
801
 
        try:
802
 
            suffix = unicode(s[-1])
803
 
            value = int(s[:-1])
804
 
            if suffix == u"d":
805
 
                delta = datetime.timedelta(value)
806
 
            elif suffix == u"s":
807
 
                delta = datetime.timedelta(0, value)
808
 
            elif suffix == u"m":
809
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
810
 
            elif suffix == u"h":
811
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
812
 
            elif suffix == u"w":
813
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
814
 
            else:
815
 
                raise ValueError
816
 
        except (ValueError, IndexError):
 
425
    try:
 
426
        suffix=unicode(interval[-1])
 
427
        value=int(interval[:-1])
 
428
        if suffix == u"d":
 
429
            delta = datetime.timedelta(value)
 
430
        elif suffix == u"s":
 
431
            delta = datetime.timedelta(0, value)
 
432
        elif suffix == u"m":
 
433
            delta = datetime.timedelta(0, 0, 0, 0, value)
 
434
        elif suffix == u"h":
 
435
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
436
        elif suffix == u"w":
 
437
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
438
        else:
817
439
            raise ValueError
818
 
        timevalue += delta
819
 
    return timevalue
 
440
    except (ValueError, IndexError):
 
441
        raise ValueError
 
442
    return delta
 
443
 
 
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()
820
476
 
821
477
 
822
478
def server_state_changed(state):
823
 
    """Derived from the Avahi example code"""
 
479
    """From the Avahi server example code"""
824
480
    if state == avahi.SERVER_COLLISION:
825
 
        logger.error(u"Zeroconf server name collision")
826
 
        service.remove()
 
481
        logger.warning(u"Server name collision")
 
482
        remove_service()
827
483
    elif state == avahi.SERVER_RUNNING:
828
 
        service.add()
 
484
        add_service()
829
485
 
830
486
 
831
487
def entry_group_state_changed(state, error):
832
 
    """Derived from the Avahi example code"""
833
 
    logger.debug(u"Avahi state change: %i", state)
 
488
    """From the Avahi server example code"""
 
489
    global serviceName, server, rename_count
 
490
    
 
491
    logger.debug(u"state change: %i", state)
834
492
    
835
493
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
836
 
        logger.debug(u"Zeroconf service established.")
 
494
        logger.debug(u"Service established.")
837
495
    elif state == avahi.ENTRY_GROUP_COLLISION:
838
 
        logger.warning(u"Zeroconf service name collision.")
839
 
        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()
840
510
    elif state == avahi.ENTRY_GROUP_FAILURE:
841
 
        logger.critical(u"Avahi: Error in group state changed %s",
842
 
                        unicode(error))
843
 
        raise AvahiGroupError(u"State changed: %s" % unicode(error))
 
511
        logger.error(u"Error in group state changed %s",
 
512
                     unicode(error))
 
513
        main_loop.quit()
 
514
        return
 
515
 
844
516
 
845
517
def if_nametoindex(interface):
846
 
    """Call the C function if_nametoindex(), or equivalent"""
847
 
    global if_nametoindex
 
518
    """Call the C function if_nametoindex()"""
848
519
    try:
849
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
850
 
                          (ctypes.util.find_library("c"))
851
 
                          .if_nametoindex)
 
520
        libc = ctypes.cdll.LoadLibrary("libc.so.6")
 
521
        return libc.if_nametoindex(interface)
852
522
    except (OSError, AttributeError):
853
523
        if "struct" not in sys.modules:
854
524
            import struct
855
525
        if "fcntl" not in sys.modules:
856
526
            import fcntl
857
 
        def if_nametoindex(interface):
858
 
            "Get an interface index the hard way, i.e. using fcntl()"
859
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
860
 
            with closing(socket.socket()) as s:
861
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
862
 
                                    struct.pack("16s16x", interface))
863
 
            interface_index = struct.unpack("I", ifreq[16:20])[0]
864
 
            return interface_index
865
 
    return if_nametoindex(interface)
866
 
 
867
 
 
868
 
def daemon(nochdir = False, noclose = False):
869
 
    """See daemon(3).  Standard BSD Unix function.
870
 
    This should really exist as os.daemon, but it doesn't (yet)."""
871
 
    if os.fork():
872
 
        sys.exit()
873
 
    os.setsid()
874
 
    if not nochdir:
875
 
        os.chdir("/")
876
 
    if os.fork():
877
 
        sys.exit()
878
 
    if not noclose:
879
 
        # Close all standard open file descriptors
880
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
881
 
        if not stat.S_ISCHR(os.fstat(null).st_mode):
882
 
            raise OSError(errno.ENODEV,
883
 
                          "/dev/null not a character device")
884
 
        os.dup2(null, sys.stdin.fileno())
885
 
        os.dup2(null, sys.stdout.fileno())
886
 
        os.dup2(null, sys.stderr.fileno())
887
 
        if null > 2:
888
 
            os.close(null)
889
 
 
890
 
 
891
 
def main():
892
 
    parser = OptionParser(version = "%%prog %s" % version)
 
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()
893
538
    parser.add_option("-i", "--interface", type="string",
894
 
                      metavar="IF", help="Bind to interface IF")
895
 
    parser.add_option("-a", "--address", type="string",
896
 
                      help="Address to listen for requests on")
897
 
    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,
898
554
                      help="Port number to receive requests on")
899
 
    parser.add_option("--check", action="store_true",
 
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
    parser.add_option("--check", action="store_true", default=False,
900
562
                      help="Run self-test")
901
 
    parser.add_option("--debug", action="store_true",
902
 
                      help="Debug mode; run in foreground and log to"
903
 
                      " terminal")
904
 
    parser.add_option("--priority", type="string", help="GnuTLS"
905
 
                      " priority string (see GnuTLS documentation)")
906
 
    parser.add_option("--servicename", type="string", metavar="NAME",
907
 
                      help="Zeroconf service name")
908
 
    parser.add_option("--configdir", type="string",
909
 
                      default="/etc/mandos", metavar="DIR",
910
 
                      help="Directory to search for configuration"
911
 
                      " files")
912
 
    parser.add_option("--no-dbus", action="store_false",
913
 
                      dest="use_dbus",
914
 
                      help="Do not provide D-Bus system bus"
915
 
                      " interface")
916
 
    options = parser.parse_args()[0]
 
563
    parser.add_option("--debug", action="store_true", default=False,
 
564
                      help="Debug mode")
 
565
    (options, args) = parser.parse_args()
917
566
    
918
567
    if options.check:
919
568
        import doctest
920
569
        doctest.testmod()
921
570
        sys.exit()
922
571
    
923
 
    # Default values for config file for server-global settings
924
 
    server_defaults = { "interface": "",
925
 
                        "address": "",
926
 
                        "port": "",
927
 
                        "debug": "False",
928
 
                        "priority":
929
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
930
 
                        "servicename": "Mandos",
931
 
                        "use_dbus": "True",
932
 
                        }
933
 
    
934
 
    # Parse config file for server-global settings
935
 
    server_config = ConfigParser.SafeConfigParser(server_defaults)
936
 
    del server_defaults
937
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
938
 
    # Convert the SafeConfigParser object to a dict
939
 
    server_settings = server_config.defaults()
940
 
    # Use getboolean on the boolean config options
941
 
    server_settings["debug"] = (server_config.getboolean
942
 
                                ("DEFAULT", "debug"))
943
 
    server_settings["use_dbus"] = (server_config.getboolean
944
 
                                   ("DEFAULT", "use_dbus"))
945
 
    del server_config
946
 
    
947
 
    # Override the settings from the config file with command line
948
 
    # options, if set.
949
 
    for option in ("interface", "address", "port", "debug",
950
 
                   "priority", "servicename", "configdir",
951
 
                   "use_dbus"):
952
 
        value = getattr(options, option)
953
 
        if value is not None:
954
 
            server_settings[option] = value
955
 
    del options
956
 
    # Now we have our good server settings in "server_settings"
957
 
    
958
 
    # For convenience
959
 
    debug = server_settings["debug"]
960
 
    use_dbus = server_settings["use_dbus"]
961
 
    
962
 
    if not debug:
963
 
        syslogger.setLevel(logging.WARNING)
964
 
        console.setLevel(logging.WARNING)
965
 
    
966
 
    if server_settings["servicename"] != "Mandos":
967
 
        syslogger.setFormatter(logging.Formatter
968
 
                               ('Mandos (%s): %%(levelname)s:'
969
 
                                ' %%(message)s'
970
 
                                % server_settings["servicename"]))
971
 
    
972
 
    # Parse config file with clients
973
 
    client_defaults = { "timeout": "1h",
974
 
                        "interval": "5m",
975
 
                        "checker": "fping -q -- %(host)s",
976
 
                        "host": "",
977
 
                        }
978
 
    client_config = ConfigParser.SafeConfigParser(client_defaults)
979
 
    client_config.read(os.path.join(server_settings["configdir"],
980
 
                                    "clients.conf"))
981
 
    
982
 
    clients = Set()
983
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
984
 
                                 server_settings["port"]),
985
 
                                TCP_handler,
986
 
                                settings=server_settings,
987
 
                                clients=clients)
988
 
    pidfilename = "/var/run/mandos.pid"
989
 
    try:
990
 
        pidfile = open(pidfilename, "w")
991
 
    except IOError, error:
992
 
        logger.error("Could not open file %r", pidfilename)
993
 
    
994
 
    try:
995
 
        uid = pwd.getpwnam("_mandos").pw_uid
996
 
    except KeyError:
997
 
        try:
998
 
            uid = pwd.getpwnam("mandos").pw_uid
999
 
        except KeyError:
1000
 
            try:
1001
 
                uid = pwd.getpwnam("nobody").pw_uid
1002
 
            except KeyError:
1003
 
                uid = 65534
1004
 
    try:
1005
 
        gid = pwd.getpwnam("_mandos").pw_gid
1006
 
    except KeyError:
1007
 
        try:
1008
 
            gid = pwd.getpwnam("mandos").pw_gid
1009
 
        except KeyError:
1010
 
            try:
1011
 
                gid = pwd.getpwnam("nogroup").pw_gid
1012
 
            except KeyError:
1013
 
                gid = 65534
1014
 
    try:
1015
 
        os.setuid(uid)
1016
 
        os.setgid(gid)
1017
 
    except OSError, error:
1018
 
        if error[0] != errno.EPERM:
1019
 
            raise error
1020
 
    
1021
 
    global service
1022
 
    service = AvahiService(name = server_settings["servicename"],
1023
 
                           servicetype = "_mandos._tcp", )
1024
 
    if server_settings["interface"]:
1025
 
        service.interface = (if_nametoindex
1026
 
                             (server_settings["interface"]))
1027
 
    
1028
 
    global main_loop
1029
 
    global bus
1030
 
    global server
1031
 
    # 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
1032
589
    DBusGMainLoop(set_as_default=True )
1033
590
    main_loop = gobject.MainLoop()
1034
591
    bus = dbus.SystemBus()
1035
 
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1036
 
                                           avahi.DBUS_PATH_SERVER),
1037
 
                            avahi.DBUS_INTERFACE_SERVER)
 
592
    server = dbus.Interface(
 
593
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
594
            avahi.DBUS_INTERFACE_SERVER )
1038
595
    # End of Avahi example code
1039
 
    if use_dbus:
1040
 
        bus_name = dbus.service.BusName(u"org.mandos-system.Mandos",
1041
 
                                        bus)
1042
 
    
1043
 
    clients.update(Set(Client(name = section,
1044
 
                              config
1045
 
                              = dict(client_config.items(section)),
1046
 
                              use_dbus = use_dbus)
 
596
    
 
597
    debug = options.debug
 
598
    
 
599
    clients = Set()
 
600
    def remove_from_clients(client):
 
601
        clients.remove(client)
 
602
        if not clients:
 
603
            logger.debug(u"No clients left, exiting")
 
604
            main_loop.quit()
 
605
    
 
606
    clients.update(Set(Client(name=section, options=options,
 
607
                              stop_hook = remove_from_clients,
 
608
                              **(dict(client_config\
 
609
                                      .items(section))))
1047
610
                       for section in client_config.sections()))
1048
 
    if not clients:
1049
 
        logger.critical(u"No clients defined")
1050
 
        sys.exit(1)
1051
 
    
1052
 
    if debug:
1053
 
        # Redirect stdin so all checkers get /dev/null
1054
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1055
 
        os.dup2(null, sys.stdin.fileno())
1056
 
        if null > 2:
1057
 
            os.close(null)
1058
 
    else:
1059
 
        # No console logging
1060
 
        logger.removeHandler(console)
1061
 
        # Close all input and output, do double fork, etc.
1062
 
        daemon()
1063
 
    
1064
 
    try:
1065
 
        pid = os.getpid()
1066
 
        pidfile.write(str(pid) + "\n")
1067
 
        pidfile.close()
1068
 
        del pidfile
1069
 
    except IOError:
1070
 
        logger.error(u"Could not write to file %r with PID %d",
1071
 
                     pidfilename, pid)
1072
 
    except NameError:
1073
 
        # "pidfile" was never created
1074
 
        pass
1075
 
    del pidfilename
1076
 
    
1077
 
    def cleanup():
1078
 
        "Cleanup function; run on exit"
1079
 
        global group
1080
 
        # From the Avahi example code
1081
 
        if not group is None:
1082
 
            group.Free()
1083
 
            group = None
1084
 
        # End of Avahi example code
1085
 
        
1086
 
        while clients:
1087
 
            client = clients.pop()
1088
 
            client.disable_hook = None
1089
 
            client.disable()
1090
 
    
1091
 
    atexit.register(cleanup)
1092
 
    
1093
 
    if not debug:
1094
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1095
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1096
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1097
 
    
1098
 
    if use_dbus:
1099
 
        class MandosServer(dbus.service.Object):
1100
 
            """A D-Bus proxy object"""
1101
 
            def __init__(self):
1102
 
                dbus.service.Object.__init__(self, bus,
1103
 
                                             "/Mandos")
1104
 
            _interface = u"org.mandos_system.Mandos"
1105
 
 
1106
 
            @dbus.service.signal(_interface, signature="oa{sv}")
1107
 
            def ClientAdded(self, objpath, properties):
1108
 
                "D-Bus signal"
1109
 
                pass
1110
 
 
1111
 
            @dbus.service.signal(_interface, signature="o")
1112
 
            def ClientRemoved(self, objpath):
1113
 
                "D-Bus signal"
1114
 
                pass
1115
 
 
1116
 
            @dbus.service.method(_interface, out_signature="ao")
1117
 
            def GetAllClients(self):
1118
 
                return dbus.Array(c.dbus_object_path for c in clients)
1119
 
 
1120
 
            @dbus.service.method(_interface, out_signature="a{oa{sv}}")
1121
 
            def GetAllClientsWithProperties(self):
1122
 
                return dbus.Dictionary(
1123
 
                    ((c.dbus_object_path, c.GetAllProperties())
1124
 
                     for c in clients),
1125
 
                    signature="oa{sv}")
1126
 
 
1127
 
            @dbus.service.method(_interface, in_signature="o")
1128
 
            def RemoveClient(self, object_path):
1129
 
                for c in clients:
1130
 
                    if c.dbus_object_path == object_path:
1131
 
                        clients.remove(c)
1132
 
                        # Don't signal anything except ClientRemoved
1133
 
                        c.use_dbus = False
1134
 
                        c.disable()
1135
 
                        # Emit D-Bus signal
1136
 
                        self.ClientRemoved(object_path)
1137
 
                        return
1138
 
                raise KeyError
1139
 
 
1140
 
            del _interface
1141
 
    
1142
 
        mandos_server = MandosServer()
1143
 
    
1144
611
    for client in clients:
1145
 
        if use_dbus:
1146
 
            # Emit D-Bus signal
1147
 
            mandos_server.ClientAdded(client.dbus_object_path,
1148
 
                                      client.GetAllProperties())
1149
 
        client.enable()
1150
 
    
1151
 
    tcp_server.enable()
1152
 
    tcp_server.server_activate()
1153
 
    
1154
 
    # Find out what port we got
1155
 
    service.port = tcp_server.socket.getsockname()[1]
1156
 
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
1157
 
                u" scope_id %d" % tcp_server.socket.getsockname())
1158
 
    
1159
 
    #service.interface = tcp_server.socket.getsockname()[3]
1160
 
    
 
612
        client.start()
 
613
    
 
614
    tcp_server = IPv6_TCPServer((None, options.port),
 
615
                                tcp_handler,
 
616
                                options=options,
 
617
                                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)
1161
634
    try:
1162
 
        # From the Avahi example code
1163
 
        server.connect_to_signal("StateChanged", server_state_changed)
1164
 
        try:
1165
 
            server_state_changed(server.GetState())
1166
 
        except dbus.exceptions.DBusException, error:
1167
 
            logger.critical(u"DBusException: %s", error)
1168
 
            sys.exit(1)
1169
 
        # End of Avahi example code
1170
 
        
1171
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1172
 
                             lambda *args, **kwargs:
1173
 
                             (tcp_server.handle_request
1174
 
                              (*args[2:], **kwargs) or True))
1175
 
        
1176
 
        logger.debug(u"Starting main loop")
1177
635
        main_loop.run()
1178
 
    except AvahiError, error:
1179
 
        logger.critical(u"AvahiError: %s", error)
1180
 
        sys.exit(1)
1181
636
    except KeyboardInterrupt:
1182
 
        if debug:
1183
 
            print
 
637
        print
 
638
    
 
639
    # Cleanup here
1184
640
 
1185
 
if __name__ == '__main__':
1186
 
    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()