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