/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 mandos

* debian/mandos-client.postinst: Converted to Bourne shell.  Also
                                 minor message change.
* debian/mandos-client.postrm: Minor message change.
* debian/mandos.postinst: Converted to Bourne shell.  Also minor
                          message change.
* debian/mandos.prerm: Minor message change.

Show diffs side-by-side

added added

removed removed

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