/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 server.py

  • Committer: Teddy Hogeborn
  • Date: 2008-07-22 06:23:59 UTC
  • mfrom: (24.1.1 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080722062359-qti3ecst69bq3ltk
Merge.

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