/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2009-02-07 04:50:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090207045039-xkr6b80vtqwqrq8l
* Makefile (install-client-nokey): Move "initramfs-tools-script" from
                                   "/scripts/local-top/mandos" to
                                   "/scripts/init-premount/mandos".
  (uninstall-client): - '' -
* debian/mandos-client.dirs: - '' -
* initramfs-tools-script (PREREQ): Added "udev".

Show diffs side-by-side

added added

removed removed

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