/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:25:35 UTC
  • mfrom: (24.1.2 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080722062535-whz5do0b3dzw6m08
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", "remove", "server_state_changed",
10
 
# "entry_group_state_changed", "cleanup", and "activate" in the
11
 
# "AvahiService" class, 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-2011 Teddy Hogeborn
15
 
# Copyright © 2008-2011 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/>.
30
 
31
 
# Contact the authors at <mandos@recompile.se>.
32
 
33
 
 
34
 
from __future__ import (division, absolute_import, print_function,
35
 
                        unicode_literals)
36
 
 
37
 
import SocketServer as socketserver
 
27
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
28
 
29
# Contact the authors at <https://www.fukt.bsnet.se/~belorn/> and
 
30
# <https://www.fukt.bsnet.se/~teddy/>.
 
31
 
32
 
 
33
from __future__ import division
 
34
 
 
35
import SocketServer
38
36
import socket
39
 
import argparse
 
37
import select
 
38
from optparse import OptionParser
40
39
import datetime
41
40
import errno
42
41
import gnutls.crypto
45
44
import gnutls.library.functions
46
45
import gnutls.library.constants
47
46
import gnutls.library.types
48
 
import ConfigParser as configparser
 
47
import ConfigParser
49
48
import sys
50
49
import re
51
50
import os
52
51
import signal
 
52
from sets import Set
53
53
import subprocess
54
54
import atexit
55
55
import stat
56
56
import logging
57
57
import logging.handlers
58
 
import pwd
59
 
import contextlib
60
 
import struct
61
 
import fcntl
62
 
import functools
63
 
import cPickle as pickle
64
 
import multiprocessing
65
 
import types
66
58
 
67
59
import dbus
68
 
import dbus.service
69
60
import gobject
70
61
import avahi
71
62
from dbus.mainloop.glib import DBusGMainLoop
72
63
import ctypes
73
 
import ctypes.util
74
 
import xml.dom.minidom
75
 
import inspect
76
 
 
77
 
try:
78
 
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
79
 
except AttributeError:
80
 
    try:
81
 
        from IN import SO_BINDTODEVICE
82
 
    except ImportError:
83
 
        SO_BINDTODEVICE = None
84
 
 
85
 
 
86
 
version = "1.4.1"
87
 
 
88
 
#logger = logging.getLogger('mandos')
 
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
 
 
76
 
89
77
logger = logging.Logger('mandos')
90
 
syslogger = (logging.handlers.SysLogHandler
91
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
 
              address = str("/dev/log")))
93
 
syslogger.setFormatter(logging.Formatter
94
 
                       ('Mandos [%(process)d]: %(levelname)s:'
95
 
                        ' %(message)s'))
 
78
syslogger = logging.handlers.SysLogHandler\
 
79
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
 
80
syslogger.setFormatter(logging.Formatter\
 
81
                        ('%(levelname)s: %(message)s'))
96
82
logger.addHandler(syslogger)
97
 
 
98
 
console = logging.StreamHandler()
99
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
100
 
                                       ' %(levelname)s:'
101
 
                                       ' %(message)s'))
102
 
logger.addHandler(console)
103
 
 
104
 
class AvahiError(Exception):
105
 
    def __init__(self, value, *args, **kwargs):
106
 
        self.value = value
107
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
108
 
    def __unicode__(self):
109
 
        return unicode(repr(self.value))
110
 
 
111
 
class AvahiServiceError(AvahiError):
112
 
    pass
113
 
 
114
 
class AvahiGroupError(AvahiError):
115
 
    pass
116
 
 
117
 
 
118
 
class AvahiService(object):
119
 
    """An Avahi (Zeroconf) service.
120
 
    
121
 
    Attributes:
122
 
    interface: integer; avahi.IF_UNSPEC or an interface index.
123
 
               Used to optionally bind to the specified interface.
124
 
    name: string; Example: 'Mandos'
125
 
    type: string; Example: '_mandos._tcp'.
126
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
127
 
    port: integer; what port to announce
128
 
    TXT: list of strings; TXT record for the service
129
 
    domain: string; Domain to publish on, default to .local if empty.
130
 
    host: string; Host to publish records for, default is localhost
131
 
    max_renames: integer; maximum number of renames
132
 
    rename_count: integer; counter so we only rename after collisions
133
 
                  a sensible number of times
134
 
    group: D-Bus Entry Group
135
 
    server: D-Bus Server
136
 
    bus: dbus.SystemBus()
137
 
    """
138
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
139
 
                 servicetype = None, port = None, TXT = None,
140
 
                 domain = "", host = "", max_renames = 32768,
141
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
142
 
        self.interface = interface
143
 
        self.name = name
144
 
        self.type = servicetype
145
 
        self.port = port
146
 
        self.TXT = TXT if TXT is not None else []
147
 
        self.domain = domain
148
 
        self.host = host
149
 
        self.rename_count = 0
150
 
        self.max_renames = max_renames
151
 
        self.protocol = protocol
152
 
        self.group = None       # our entry group
153
 
        self.server = None
154
 
        self.bus = bus
155
 
        self.entry_group_state_changed_match = None
156
 
    def rename(self):
157
 
        """Derived from the Avahi example code"""
158
 
        if self.rename_count >= self.max_renames:
159
 
            logger.critical("No suitable Zeroconf service name found"
160
 
                            " after %i retries, exiting.",
161
 
                            self.rename_count)
162
 
            raise AvahiServiceError("Too many renames")
163
 
        self.name = unicode(self.server
164
 
                            .GetAlternativeServiceName(self.name))
165
 
        logger.info("Changing Zeroconf service name to %r ...",
166
 
                    self.name)
167
 
        syslogger.setFormatter(logging.Formatter
168
 
                               ('Mandos (%s) [%%(process)d]:'
169
 
                                ' %%(levelname)s: %%(message)s'
170
 
                                % self.name))
171
 
        self.remove()
172
 
        try:
173
 
            self.add()
174
 
        except dbus.exceptions.DBusException as error:
175
 
            logger.critical("DBusException: %s", error)
176
 
            self.cleanup()
177
 
            os._exit(1)
178
 
        self.rename_count += 1
179
 
    def remove(self):
180
 
        """Derived from the Avahi example code"""
181
 
        if self.entry_group_state_changed_match is not None:
182
 
            self.entry_group_state_changed_match.remove()
183
 
            self.entry_group_state_changed_match = None
184
 
        if self.group is not None:
185
 
            self.group.Reset()
186
 
    def add(self):
187
 
        """Derived from the Avahi example code"""
188
 
        self.remove()
189
 
        if self.group is None:
190
 
            self.group = dbus.Interface(
191
 
                self.bus.get_object(avahi.DBUS_NAME,
192
 
                                    self.server.EntryGroupNew()),
193
 
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
194
 
        self.entry_group_state_changed_match = (
195
 
            self.group.connect_to_signal(
196
 
                'StateChanged', self .entry_group_state_changed))
197
 
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
198
 
                     self.name, self.type)
199
 
        self.group.AddService(
200
 
            self.interface,
201
 
            self.protocol,
202
 
            dbus.UInt32(0),     # flags
203
 
            self.name, self.type,
204
 
            self.domain, self.host,
205
 
            dbus.UInt16(self.port),
206
 
            avahi.string_array_to_txt_array(self.TXT))
207
 
        self.group.Commit()
208
 
    def entry_group_state_changed(self, state, error):
209
 
        """Derived from the Avahi example code"""
210
 
        logger.debug("Avahi entry group state change: %i", state)
211
 
        
212
 
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
213
 
            logger.debug("Zeroconf service established.")
214
 
        elif state == avahi.ENTRY_GROUP_COLLISION:
215
 
            logger.info("Zeroconf service name collision.")
216
 
            self.rename()
217
 
        elif state == avahi.ENTRY_GROUP_FAILURE:
218
 
            logger.critical("Avahi: Error in group state changed %s",
219
 
                            unicode(error))
220
 
            raise AvahiGroupError("State changed: %s"
221
 
                                  % unicode(error))
222
 
    def cleanup(self):
223
 
        """Derived from the Avahi example code"""
224
 
        if self.group is not None:
225
 
            try:
226
 
                self.group.Free()
227
 
            except (dbus.exceptions.UnknownMethodException,
228
 
                    dbus.exceptions.DBusException) as e:
229
 
                pass
230
 
            self.group = None
231
 
        self.remove()
232
 
    def server_state_changed(self, state, error=None):
233
 
        """Derived from the Avahi example code"""
234
 
        logger.debug("Avahi server state change: %i", state)
235
 
        bad_states = { avahi.SERVER_INVALID:
236
 
                           "Zeroconf server invalid",
237
 
                       avahi.SERVER_REGISTERING: None,
238
 
                       avahi.SERVER_COLLISION:
239
 
                           "Zeroconf server name collision",
240
 
                       avahi.SERVER_FAILURE:
241
 
                           "Zeroconf server failure" }
242
 
        if state in bad_states:
243
 
            if bad_states[state] is not None:
244
 
                if error is None:
245
 
                    logger.error(bad_states[state])
246
 
                else:
247
 
                    logger.error(bad_states[state] + ": %r", error)
248
 
            self.cleanup()
249
 
        elif state == avahi.SERVER_RUNNING:
250
 
            self.add()
251
 
        else:
252
 
            if error is None:
253
 
                logger.debug("Unknown state: %r", state)
254
 
            else:
255
 
                logger.debug("Unknown state: %r: %r", state, error)
256
 
    def activate(self):
257
 
        """Derived from the Avahi example code"""
258
 
        if self.server is None:
259
 
            self.server = dbus.Interface(
260
 
                self.bus.get_object(avahi.DBUS_NAME,
261
 
                                    avahi.DBUS_PATH_SERVER,
262
 
                                    follow_name_owner_changes=True),
263
 
                avahi.DBUS_INTERFACE_SERVER)
264
 
        self.server.connect_to_signal("StateChanged",
265
 
                                 self.server_state_changed)
266
 
        self.server_state_changed(self.server.GetState())
267
 
 
268
 
 
269
 
def _timedelta_to_milliseconds(td):
270
 
    "Convert a datetime.timedelta() to milliseconds"
271
 
    return ((td.days * 24 * 60 * 60 * 1000)
272
 
            + (td.seconds * 1000)
273
 
            + (td.microseconds // 1000))
274
 
        
 
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
 
89
# 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
 
99
# End of Avahi example code
 
100
 
 
101
 
275
102
class Client(object):
276
103
    """A representation of a client host served by this server.
277
 
    
278
104
    Attributes:
279
 
    _approved:   bool(); 'None' if not yet approved/disapproved
280
 
    approval_delay: datetime.timedelta(); Time to wait for approval
281
 
    approval_duration: datetime.timedelta(); Duration of one approval
282
 
    checker:    subprocess.Popen(); a running checker process used
283
 
                                    to see if the client lives.
284
 
                                    'None' if no process is running.
285
 
    checker_callback_tag: a gobject event source tag, or None
286
 
    checker_command: string; External command which is run to check
287
 
                     if client lives.  %() expansions are done at
 
105
    name:      string; from the config file, used in log messages
 
106
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
107
                 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.
 
119
    checker_initiator_tag: a gobject event source tag, or None
 
120
    stop_initiator_tag:    - '' -
 
121
    checker_callback_tag:  - '' -
 
122
    checker_command: string; External command which is run to check if
 
123
                     client lives.  %()s expansions are done at
288
124
                     runtime with vars(self) as dict, so that for
289
125
                     instance %(name)s can be used in the command.
290
 
    checker_initiator_tag: a gobject event source tag, or None
291
 
    created:    datetime.datetime(); (UTC) object creation
292
 
    current_checker_command: string; current running checker_command
293
 
    disable_hook:  If set, called by disable() as disable_hook(self)
294
 
    disable_initiator_tag: a gobject event source tag, or None
295
 
    enabled:    bool()
296
 
    fingerprint: string (40 or 32 hexadecimal digits); used to
297
 
                 uniquely identify the client
298
 
    host:       string; available for use by the checker command
299
 
    interval:   datetime.timedelta(); How often to start a new checker
300
 
    last_approval_request: datetime.datetime(); (UTC) or None
301
 
    last_checked_ok: datetime.datetime(); (UTC) or None
302
 
    last_enabled: datetime.datetime(); (UTC)
303
 
    name:       string; from the config file, used in log messages and
304
 
                        D-Bus identifiers
305
 
    secret:     bytestring; sent verbatim (over TLS) to client
306
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
307
 
                                      until this client is disabled
308
 
    extended_timeout:   extra long timeout when password has been sent
309
 
    runtime_expansions: Allowed attributes for runtime expansion.
310
 
    expires:    datetime.datetime(); time (UTC) when a client will be
311
 
                disabled, or None
 
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: - '' -
312
131
    """
313
 
    
314
 
    runtime_expansions = ("approval_delay", "approval_duration",
315
 
                          "created", "enabled", "fingerprint",
316
 
                          "host", "interval", "last_checked_ok",
317
 
                          "last_enabled", "name", "timeout")
318
 
    
319
 
    def timeout_milliseconds(self):
320
 
        "Return the 'timeout' attribute in milliseconds"
321
 
        return _timedelta_to_milliseconds(self.timeout)
322
 
    
323
 
    def extended_timeout_milliseconds(self):
324
 
        "Return the 'extended_timeout' attribute in milliseconds"
325
 
        return _timedelta_to_milliseconds(self.extended_timeout)
326
 
    
327
 
    def interval_milliseconds(self):
328
 
        "Return the 'interval' attribute in milliseconds"
329
 
        return _timedelta_to_milliseconds(self.interval)
330
 
    
331
 
    def approval_delay_milliseconds(self):
332
 
        return _timedelta_to_milliseconds(self.approval_delay)
333
 
    
334
 
    def __init__(self, name = None, disable_hook=None, config=None):
335
 
        """Note: the 'checker' key in 'config' sets the
336
 
        'checker_command' attribute and *not* the 'checker'
337
 
        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.."""
338
160
        self.name = name
339
 
        if config is None:
340
 
            config = {}
341
 
        logger.debug("Creating client %r", self.name)
342
 
        # Uppercase and remove spaces from fingerprint for later
343
 
        # comparison purposes with return value from the fingerprint()
344
 
        # function
345
 
        self.fingerprint = (config["fingerprint"].upper()
346
 
                            .replace(" ", ""))
347
 
        logger.debug("  Fingerprint: %s", self.fingerprint)
348
 
        if "secret" in config:
349
 
            self.secret = config["secret"].decode("base64")
350
 
        elif "secfile" in config:
351
 
            with open(os.path.expanduser(os.path.expandvars
352
 
                                         (config["secfile"])),
353
 
                      "rb") as secfile:
354
 
                self.secret = secfile.read()
 
161
        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"")
 
166
        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()
355
173
        else:
356
 
            raise TypeError("No secret or secfile for client %s"
357
 
                            % self.name)
358
 
        self.host = config.get("host", "")
359
 
        self.created = datetime.datetime.utcnow()
360
 
        self.enabled = False
361
 
        self.last_approval_request = None
362
 
        self.last_enabled = None
363
 
        self.last_checked_ok = None
364
 
        self.timeout = string_to_delta(config["timeout"])
365
 
        self.extended_timeout = string_to_delta(config
366
 
                                                ["extended_timeout"])
367
 
        self.interval = string_to_delta(config["interval"])
368
 
        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
369
182
        self.checker = None
370
183
        self.checker_initiator_tag = None
371
 
        self.disable_initiator_tag = None
372
 
        self.expires = None
 
184
        self.stop_initiator_tag = None
373
185
        self.checker_callback_tag = None
374
 
        self.checker_command = config["checker"]
375
 
        self.current_checker_command = None
376
 
        self.last_connect = None
377
 
        self._approved = None
378
 
        self.approved_by_default = config.get("approved_by_default",
379
 
                                              True)
380
 
        self.approvals_pending = 0
381
 
        self.approval_delay = string_to_delta(
382
 
            config["approval_delay"])
383
 
        self.approval_duration = string_to_delta(
384
 
            config["approval_duration"])
385
 
        self.changedstate = (multiprocessing_manager
386
 
                             .Condition(multiprocessing_manager
387
 
                                        .Lock()))
388
 
    
389
 
    def send_changedstate(self):
390
 
        self.changedstate.acquire()
391
 
        self.changedstate.notify_all()
392
 
        self.changedstate.release()
393
 
    
394
 
    def enable(self):
 
186
        self.check_command = checker
 
187
    def start(self):
395
188
        """Start this client's checker and timeout hooks"""
396
 
        if getattr(self, "enabled", False):
397
 
            # Already enabled
398
 
            return
399
 
        self.send_changedstate()
400
189
        # Schedule a new checker to be started an 'interval' from now,
401
190
        # and every interval from then on.
402
 
        self.checker_initiator_tag = (gobject.timeout_add
403
 
                                      (self.interval_milliseconds(),
404
 
                                       self.start_checker))
405
 
        # Schedule a disable() when 'timeout' has passed
406
 
        self.expires = datetime.datetime.utcnow() + self.timeout
407
 
        self.disable_initiator_tag = (gobject.timeout_add
408
 
                                   (self.timeout_milliseconds(),
409
 
                                    self.disable))
410
 
        self.enabled = True
411
 
        self.last_enabled = datetime.datetime.utcnow()
 
191
        self.checker_initiator_tag = gobject.timeout_add\
 
192
                                     (self._interval_milliseconds,
 
193
                                      self.start_checker)
412
194
        # Also start a new checker *right now*.
413
195
        self.start_checker()
414
 
    
415
 
    def disable(self, quiet=True):
416
 
        """Disable this client."""
417
 
        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:
418
209
            return False
419
 
        if not quiet:
420
 
            self.send_changedstate()
421
 
        if not quiet:
422
 
            logger.info("Disabling client %s", self.name)
423
 
        if getattr(self, "disable_initiator_tag", False):
424
 
            gobject.source_remove(self.disable_initiator_tag)
425
 
            self.disable_initiator_tag = None
426
 
        self.expires = None
427
 
        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:
428
216
            gobject.source_remove(self.checker_initiator_tag)
429
217
            self.checker_initiator_tag = None
430
218
        self.stop_checker()
431
 
        if self.disable_hook:
432
 
            self.disable_hook(self)
433
 
        self.enabled = False
 
219
        if self.stop_hook:
 
220
            self.stop_hook(self)
434
221
        # Do not run this again if called by a gobject.timeout_add
435
222
        return False
436
 
    
437
223
    def __del__(self):
438
 
        self.disable_hook = None
439
 
        self.disable()
440
 
    
441
 
    def checker_callback(self, pid, condition, command):
 
224
        self.stop_hook = None
 
225
        self.stop()
 
226
    def checker_callback(self, pid, condition):
442
227
        """The checker has completed, so take appropriate actions."""
 
228
        now = datetime.datetime.now()
443
229
        self.checker_callback_tag = None
444
230
        self.checker = None
445
 
        if os.WIFEXITED(condition):
446
 
            exitstatus = os.WEXITSTATUS(condition)
447
 
            if exitstatus == 0:
448
 
                logger.info("Checker for %(name)s succeeded",
449
 
                            vars(self))
450
 
                self.checked_ok()
451
 
            else:
452
 
                logger.info("Checker for %(name)s failed",
453
 
                            vars(self))
454
 
        else:
455
 
            logger.warning("Checker for %(name)s crashed?",
 
231
        if os.WIFEXITED(condition) \
 
232
               and (os.WEXITSTATUS(condition) == 0):
 
233
            logger.debug(u"Checker for %(name)s succeeded",
 
234
                         vars(self))
 
235
            self.last_seen = now
 
236
            gobject.source_remove(self.stop_initiator_tag)
 
237
            self.stop_initiator_tag = gobject.timeout_add\
 
238
                                      (self._timeout_milliseconds,
 
239
                                       self.stop)
 
240
        elif not os.WIFEXITED(condition):
 
241
            logger.warning(u"Checker for %(name)s crashed?",
456
242
                           vars(self))
457
 
    
458
 
    def checked_ok(self, timeout=None):
459
 
        """Bump up the timeout for this client.
460
 
        
461
 
        This should only be called when the client has been seen,
462
 
        alive and well.
463
 
        """
464
 
        if timeout is None:
465
 
            timeout = self.timeout
466
 
        self.last_checked_ok = datetime.datetime.utcnow()
467
 
        if self.disable_initiator_tag is not None:
468
 
            gobject.source_remove(self.disable_initiator_tag)
469
 
        if getattr(self, "enabled", False):
470
 
            self.disable_initiator_tag = (gobject.timeout_add
471
 
                                          (_timedelta_to_milliseconds
472
 
                                           (timeout), self.disable))
473
 
            self.expires = datetime.datetime.utcnow() + timeout
474
 
    
475
 
    def need_approval(self):
476
 
        self.last_approval_request = datetime.datetime.utcnow()
477
 
    
 
243
        else:
 
244
            logger.debug(u"Checker for %(name)s failed",
 
245
                         vars(self))
478
246
    def start_checker(self):
479
247
        """Start a new checker subprocess if one is not running.
480
 
        
481
248
        If a checker already exists, leave it running and do
482
249
        nothing."""
483
250
        # The reason for not killing a running checker is that if we
486
253
        # client would inevitably timeout, since no checker would get
487
254
        # a chance to run to completion.  If we instead leave running
488
255
        # checkers alone, the checker would have to take more time
489
 
        # than 'timeout' for the client to be disabled, which is as it
490
 
        # should be.
491
 
        
492
 
        # If a checker exists, make sure it is not a zombie
493
 
        try:
494
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
495
 
        except (AttributeError, OSError) as error:
496
 
            if (isinstance(error, OSError)
497
 
                and error.errno != errno.ECHILD):
498
 
                raise error
499
 
        else:
500
 
            if pid:
501
 
                logger.warning("Checker was a zombie")
502
 
                gobject.source_remove(self.checker_callback_tag)
503
 
                self.checker_callback(pid, status,
504
 
                                      self.current_checker_command)
505
 
        # Start a new checker if needed
 
256
        # than 'timeout' for the client to be declared invalid, which
 
257
        # is as it should be.
506
258
        if self.checker is None:
507
259
            try:
508
 
                # In case checker_command has exactly one % operator
509
 
                command = self.checker_command % self.host
 
260
                command = self.check_command % self.fqdn
510
261
            except TypeError:
511
 
                # Escape attributes for the shell
512
 
                escaped_attrs = dict(
513
 
                    (attr,
514
 
                     re.escape(unicode(str(getattr(self, attr, "")),
515
 
                                       errors=
516
 
                                       'replace')))
517
 
                    for attr in
518
 
                    self.runtime_expansions)
519
 
                
 
262
                escaped_attrs = dict((key, re.escape(str(val)))
 
263
                                     for key, val in
 
264
                                     vars(self).iteritems())
520
265
                try:
521
 
                    command = self.checker_command % escaped_attrs
522
 
                except TypeError as error:
523
 
                    logger.error('Could not format string "%s":'
524
 
                                 ' %s', self.checker_command, error)
 
266
                    command = self.check_command % escaped_attrs
 
267
                except TypeError, error:
 
268
                    logger.critical(u'Could not format string "%s":'
 
269
                                    u' %s', self.check_command, error)
525
270
                    return True # Try again later
526
 
            self.current_checker_command = command
527
271
            try:
528
 
                logger.info("Starting checker %r for %s",
529
 
                            command, self.name)
530
 
                # We don't need to redirect stdout and stderr, since
531
 
                # in normal mode, that is already done by daemon(),
532
 
                # and in debug mode we don't want to.  (Stdin is
533
 
                # always replaced by /dev/null.)
534
 
                self.checker = subprocess.Popen(command,
535
 
                                                close_fds=True,
536
 
                                                shell=True, cwd="/")
537
 
                self.checker_callback_tag = (gobject.child_watch_add
538
 
                                             (self.checker.pid,
539
 
                                              self.checker_callback,
540
 
                                              data=command))
541
 
                # The checker may have completed before the gobject
542
 
                # watch was added.  Check for this.
543
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
544
 
                if pid:
545
 
                    gobject.source_remove(self.checker_callback_tag)
546
 
                    self.checker_callback(pid, status, command)
547
 
            except OSError as error:
548
 
                logger.error("Failed to start subprocess: %s",
 
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:
 
282
                logger.error(u"Failed to start subprocess: %s",
549
283
                             error)
550
284
        # Re-run this periodically if run by gobject.timeout_add
551
285
        return True
552
 
    
553
286
    def stop_checker(self):
554
287
        """Force the checker process, if any, to stop."""
555
288
        if self.checker_callback_tag:
556
289
            gobject.source_remove(self.checker_callback_tag)
557
290
            self.checker_callback_tag = None
558
 
        if getattr(self, "checker", None) is None:
 
291
        if not hasattr(self, "checker") or self.checker is None:
559
292
            return
560
293
        logger.debug("Stopping checker for %(name)s", vars(self))
561
294
        try:
562
295
            os.kill(self.checker.pid, signal.SIGTERM)
563
 
            #time.sleep(0.5)
 
296
            #os.sleep(0.5)
564
297
            #if self.checker.poll() is None:
565
298
            #    os.kill(self.checker.pid, signal.SIGKILL)
566
 
        except OSError as error:
567
 
            if error.errno != errno.ESRCH: # No such process
 
299
        except OSError, error:
 
300
            if error.errno != errno.ESRCH:
568
301
                raise
569
302
        self.checker = None
570
 
 
571
 
 
572
 
def dbus_service_property(dbus_interface, signature="v",
573
 
                          access="readwrite", byte_arrays=False):
574
 
    """Decorators for marking methods of a DBusObjectWithProperties to
575
 
    become properties on the D-Bus.
576
 
    
577
 
    The decorated method will be called with no arguments by "Get"
578
 
    and with one argument by "Set".
579
 
    
580
 
    The parameters, where they are supported, are the same as
581
 
    dbus.service.method, except there is only "signature", since the
582
 
    type from Get() and the type sent to Set() is the same.
583
 
    """
584
 
    # Encoding deeply encoded byte arrays is not supported yet by the
585
 
    # "Set" method, so we fail early here:
586
 
    if byte_arrays and signature != "ay":
587
 
        raise ValueError("Byte arrays not supported for non-'ay'"
588
 
                         " signature %r" % signature)
589
 
    def decorator(func):
590
 
        func._dbus_is_property = True
591
 
        func._dbus_interface = dbus_interface
592
 
        func._dbus_signature = signature
593
 
        func._dbus_access = access
594
 
        func._dbus_name = func.__name__
595
 
        if func._dbus_name.endswith("_dbus_property"):
596
 
            func._dbus_name = func._dbus_name[:-14]
597
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
598
 
        return func
599
 
    return decorator
600
 
 
601
 
 
602
 
class DBusPropertyException(dbus.exceptions.DBusException):
603
 
    """A base class for D-Bus property-related exceptions
604
 
    """
605
 
    def __unicode__(self):
606
 
        return unicode(str(self))
607
 
 
608
 
 
609
 
class DBusPropertyAccessException(DBusPropertyException):
610
 
    """A property's access permissions disallows an operation.
611
 
    """
612
 
    pass
613
 
 
614
 
 
615
 
class DBusPropertyNotFound(DBusPropertyException):
616
 
    """An attempt was made to access a non-existing property.
617
 
    """
618
 
    pass
619
 
 
620
 
 
621
 
class DBusObjectWithProperties(dbus.service.Object):
622
 
    """A D-Bus object with properties.
623
 
    
624
 
    Classes inheriting from this can use the dbus_service_property
625
 
    decorator to expose methods as D-Bus properties.  It exposes the
626
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
627
 
    """
628
 
    
629
 
    @staticmethod
630
 
    def _is_dbus_property(obj):
631
 
        return getattr(obj, "_dbus_is_property", False)
632
 
    
633
 
    def _get_all_dbus_properties(self):
634
 
        """Returns a generator of (name, attribute) pairs
635
 
        """
636
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
637
 
                for cls in self.__class__.__mro__
638
 
                for name, prop in
639
 
                inspect.getmembers(cls, self._is_dbus_property))
640
 
    
641
 
    def _get_dbus_property(self, interface_name, property_name):
642
 
        """Returns a bound method if one exists which is a D-Bus
643
 
        property with the specified name and interface.
644
 
        """
645
 
        for cls in  self.__class__.__mro__:
646
 
            for name, value in (inspect.getmembers
647
 
                                (cls, self._is_dbus_property)):
648
 
                if (value._dbus_name == property_name
649
 
                    and value._dbus_interface == interface_name):
650
 
                    return value.__get__(self)
651
 
        
652
 
        # No such property
653
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
654
 
                                   + interface_name + "."
655
 
                                   + property_name)
656
 
    
657
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
658
 
                         out_signature="v")
659
 
    def Get(self, interface_name, property_name):
660
 
        """Standard D-Bus property Get() method, see D-Bus standard.
661
 
        """
662
 
        prop = self._get_dbus_property(interface_name, property_name)
663
 
        if prop._dbus_access == "write":
664
 
            raise DBusPropertyAccessException(property_name)
665
 
        value = prop()
666
 
        if not hasattr(value, "variant_level"):
667
 
            return value
668
 
        return type(value)(value, variant_level=value.variant_level+1)
669
 
    
670
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
671
 
    def Set(self, interface_name, property_name, value):
672
 
        """Standard D-Bus property Set() method, see D-Bus standard.
673
 
        """
674
 
        prop = self._get_dbus_property(interface_name, property_name)
675
 
        if prop._dbus_access == "read":
676
 
            raise DBusPropertyAccessException(property_name)
677
 
        if prop._dbus_get_args_options["byte_arrays"]:
678
 
            # The byte_arrays option is not supported yet on
679
 
            # signatures other than "ay".
680
 
            if prop._dbus_signature != "ay":
681
 
                raise ValueError
682
 
            value = dbus.ByteArray(''.join(unichr(byte)
683
 
                                           for byte in value))
684
 
        prop(value)
685
 
    
686
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
687
 
                         out_signature="a{sv}")
688
 
    def GetAll(self, interface_name):
689
 
        """Standard D-Bus property GetAll() method, see D-Bus
690
 
        standard.
691
 
        
692
 
        Note: Will not include properties with access="write".
693
 
        """
694
 
        all = {}
695
 
        for name, prop in self._get_all_dbus_properties():
696
 
            if (interface_name
697
 
                and interface_name != prop._dbus_interface):
698
 
                # Interface non-empty but did not match
699
 
                continue
700
 
            # Ignore write-only properties
701
 
            if prop._dbus_access == "write":
702
 
                continue
703
 
            value = prop()
704
 
            if not hasattr(value, "variant_level"):
705
 
                all[name] = value
706
 
                continue
707
 
            all[name] = type(value)(value, variant_level=
708
 
                                    value.variant_level+1)
709
 
        return dbus.Dictionary(all, signature="sv")
710
 
    
711
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
712
 
                         out_signature="s",
713
 
                         path_keyword='object_path',
714
 
                         connection_keyword='connection')
715
 
    def Introspect(self, object_path, connection):
716
 
        """Standard D-Bus method, overloaded to insert property tags.
717
 
        """
718
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
719
 
                                                   connection)
720
 
        try:
721
 
            document = xml.dom.minidom.parseString(xmlstring)
722
 
            def make_tag(document, name, prop):
723
 
                e = document.createElement("property")
724
 
                e.setAttribute("name", name)
725
 
                e.setAttribute("type", prop._dbus_signature)
726
 
                e.setAttribute("access", prop._dbus_access)
727
 
                return e
728
 
            for if_tag in document.getElementsByTagName("interface"):
729
 
                for tag in (make_tag(document, name, prop)
730
 
                            for name, prop
731
 
                            in self._get_all_dbus_properties()
732
 
                            if prop._dbus_interface
733
 
                            == if_tag.getAttribute("name")):
734
 
                    if_tag.appendChild(tag)
735
 
                # Add the names to the return values for the
736
 
                # "org.freedesktop.DBus.Properties" methods
737
 
                if (if_tag.getAttribute("name")
738
 
                    == "org.freedesktop.DBus.Properties"):
739
 
                    for cn in if_tag.getElementsByTagName("method"):
740
 
                        if cn.getAttribute("name") == "Get":
741
 
                            for arg in cn.getElementsByTagName("arg"):
742
 
                                if (arg.getAttribute("direction")
743
 
                                    == "out"):
744
 
                                    arg.setAttribute("name", "value")
745
 
                        elif cn.getAttribute("name") == "GetAll":
746
 
                            for arg in cn.getElementsByTagName("arg"):
747
 
                                if (arg.getAttribute("direction")
748
 
                                    == "out"):
749
 
                                    arg.setAttribute("name", "props")
750
 
            xmlstring = document.toxml("utf-8")
751
 
            document.unlink()
752
 
        except (AttributeError, xml.dom.DOMException,
753
 
                xml.parsers.expat.ExpatError) as error:
754
 
            logger.error("Failed to override Introspection method",
755
 
                         error)
756
 
        return xmlstring
757
 
 
758
 
 
759
 
def datetime_to_dbus (dt, variant_level=0):
760
 
    """Convert a UTC datetime.datetime() to a D-Bus type."""
761
 
    if dt is None:
762
 
        return dbus.String("", variant_level = variant_level)
763
 
    return dbus.String(dt.isoformat(),
764
 
                       variant_level=variant_level)
765
 
 
766
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
767
 
                                  .__metaclass__):
768
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
769
 
    will add additional D-Bus attributes matching a certain pattern.
770
 
    """
771
 
    def __new__(mcs, name, bases, attr):
772
 
        # Go through all the base classes which could have D-Bus
773
 
        # methods, signals, or properties in them
774
 
        for base in (b for b in bases
775
 
                     if issubclass(b, dbus.service.Object)):
776
 
            # Go though all attributes of the base class
777
 
            for attrname, attribute in inspect.getmembers(base):
778
 
                # Ignore non-D-Bus attributes, and D-Bus attributes
779
 
                # with the wrong interface name
780
 
                if (not hasattr(attribute, "_dbus_interface")
781
 
                    or not attribute._dbus_interface
782
 
                    .startswith("se.recompile.Mandos")):
783
 
                    continue
784
 
                # Create an alternate D-Bus interface name based on
785
 
                # the current name
786
 
                alt_interface = (attribute._dbus_interface
787
 
                                 .replace("se.recompile.Mandos",
788
 
                                          "se.bsnet.fukt.Mandos"))
789
 
                # Is this a D-Bus signal?
790
 
                if getattr(attribute, "_dbus_is_signal", False):
791
 
                    # Extract the original non-method function by
792
 
                    # black magic
793
 
                    nonmethod_func = (dict(
794
 
                            zip(attribute.func_code.co_freevars,
795
 
                                attribute.__closure__))["func"]
796
 
                                      .cell_contents)
797
 
                    # Create a new, but exactly alike, function
798
 
                    # object, and decorate it to be a new D-Bus signal
799
 
                    # with the alternate D-Bus interface name
800
 
                    new_function = (dbus.service.signal
801
 
                                    (alt_interface,
802
 
                                     attribute._dbus_signature)
803
 
                                    (types.FunctionType(
804
 
                                nonmethod_func.func_code,
805
 
                                nonmethod_func.func_globals,
806
 
                                nonmethod_func.func_name,
807
 
                                nonmethod_func.func_defaults,
808
 
                                nonmethod_func.func_closure)))
809
 
                    # Define a creator of a function to call both the
810
 
                    # old and new functions, so both the old and new
811
 
                    # signals gets sent when the function is called
812
 
                    def fixscope(func1, func2):
813
 
                        """This function is a scope container to pass
814
 
                        func1 and func2 to the "call_both" function
815
 
                        outside of its arguments"""
816
 
                        def call_both(*args, **kwargs):
817
 
                            """This function will emit two D-Bus
818
 
                            signals by calling func1 and func2"""
819
 
                            func1(*args, **kwargs)
820
 
                            func2(*args, **kwargs)
821
 
                        return call_both
822
 
                    # Create the "call_both" function and add it to
823
 
                    # the class
824
 
                    attr[attrname] = fixscope(attribute,
825
 
                                              new_function)
826
 
                # Is this a D-Bus method?
827
 
                elif getattr(attribute, "_dbus_is_method", False):
828
 
                    # Create a new, but exactly alike, function
829
 
                    # object.  Decorate it to be a new D-Bus method
830
 
                    # with the alternate D-Bus interface name.  Add it
831
 
                    # to the class.
832
 
                    attr[attrname] = (dbus.service.method
833
 
                                      (alt_interface,
834
 
                                       attribute._dbus_in_signature,
835
 
                                       attribute._dbus_out_signature)
836
 
                                      (types.FunctionType
837
 
                                       (attribute.func_code,
838
 
                                        attribute.func_globals,
839
 
                                        attribute.func_name,
840
 
                                        attribute.func_defaults,
841
 
                                        attribute.func_closure)))
842
 
                # Is this a D-Bus property?
843
 
                elif getattr(attribute, "_dbus_is_property", False):
844
 
                    # Create a new, but exactly alike, function
845
 
                    # object, and decorate it to be a new D-Bus
846
 
                    # property with the alternate D-Bus interface
847
 
                    # name.  Add it to the class.
848
 
                    attr[attrname] = (dbus_service_property
849
 
                                      (alt_interface,
850
 
                                       attribute._dbus_signature,
851
 
                                       attribute._dbus_access,
852
 
                                       attribute
853
 
                                       ._dbus_get_args_options
854
 
                                       ["byte_arrays"])
855
 
                                      (types.FunctionType
856
 
                                       (attribute.func_code,
857
 
                                        attribute.func_globals,
858
 
                                        attribute.func_name,
859
 
                                        attribute.func_defaults,
860
 
                                        attribute.func_closure)))
861
 
        return type.__new__(mcs, name, bases, attr)
862
 
 
863
 
class ClientDBus(Client, DBusObjectWithProperties):
864
 
    """A Client class using D-Bus
865
 
    
866
 
    Attributes:
867
 
    dbus_object_path: dbus.ObjectPath
868
 
    bus: dbus.SystemBus()
869
 
    """
870
 
    
871
 
    runtime_expansions = (Client.runtime_expansions
872
 
                          + ("dbus_object_path",))
873
 
    
874
 
    # dbus.service.Object doesn't use super(), so we can't either.
875
 
    
876
 
    def __init__(self, bus = None, *args, **kwargs):
877
 
        self._approvals_pending = 0
878
 
        self.bus = bus
879
 
        Client.__init__(self, *args, **kwargs)
880
 
        # Only now, when this client is initialized, can it show up on
881
 
        # the D-Bus
882
 
        client_object_name = unicode(self.name).translate(
883
 
            {ord("."): ord("_"),
884
 
             ord("-"): ord("_")})
885
 
        self.dbus_object_path = (dbus.ObjectPath
886
 
                                 ("/clients/" + client_object_name))
887
 
        DBusObjectWithProperties.__init__(self, self.bus,
888
 
                                          self.dbus_object_path)
889
 
        
890
 
    def notifychangeproperty(transform_func,
891
 
                             dbus_name, type_func=lambda x: x,
892
 
                             variant_level=1):
893
 
        """ Modify a variable so that it's a property which announces
894
 
        its changes to DBus.
895
 
 
896
 
        transform_fun: Function that takes a value and a variant_level
897
 
                       and transforms it to a D-Bus type.
898
 
        dbus_name: D-Bus name of the variable
899
 
        type_func: Function that transform the value before sending it
900
 
                   to the D-Bus.  Default: no transform
901
 
        variant_level: D-Bus variant level.  Default: 1
902
 
        """
903
 
        attrname = "_{0}".format(dbus_name)
904
 
        def setter(self, value):
905
 
            if hasattr(self, "dbus_object_path"):
906
 
                if (not hasattr(self, attrname) or
907
 
                    type_func(getattr(self, attrname, None))
908
 
                    != type_func(value)):
909
 
                    dbus_value = transform_func(type_func(value),
910
 
                                                variant_level
911
 
                                                =variant_level)
912
 
                    self.PropertyChanged(dbus.String(dbus_name),
913
 
                                         dbus_value)
914
 
            setattr(self, attrname, value)
915
 
        
916
 
        return property(lambda self: getattr(self, attrname), setter)
917
 
    
918
 
    
919
 
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
920
 
    approvals_pending = notifychangeproperty(dbus.Boolean,
921
 
                                             "ApprovalPending",
922
 
                                             type_func = bool)
923
 
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
924
 
    last_enabled = notifychangeproperty(datetime_to_dbus,
925
 
                                        "LastEnabled")
926
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
927
 
                                   type_func = lambda checker:
928
 
                                       checker is not None)
929
 
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
930
 
                                           "LastCheckedOK")
931
 
    last_approval_request = notifychangeproperty(
932
 
        datetime_to_dbus, "LastApprovalRequest")
933
 
    approved_by_default = notifychangeproperty(dbus.Boolean,
934
 
                                               "ApprovedByDefault")
935
 
    approval_delay = notifychangeproperty(dbus.UInt16,
936
 
                                          "ApprovalDelay",
937
 
                                          type_func =
938
 
                                          _timedelta_to_milliseconds)
939
 
    approval_duration = notifychangeproperty(
940
 
        dbus.UInt16, "ApprovalDuration",
941
 
        type_func = _timedelta_to_milliseconds)
942
 
    host = notifychangeproperty(dbus.String, "Host")
943
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
944
 
                                   type_func =
945
 
                                   _timedelta_to_milliseconds)
946
 
    extended_timeout = notifychangeproperty(
947
 
        dbus.UInt16, "ExtendedTimeout",
948
 
        type_func = _timedelta_to_milliseconds)
949
 
    interval = notifychangeproperty(dbus.UInt16,
950
 
                                    "Interval",
951
 
                                    type_func =
952
 
                                    _timedelta_to_milliseconds)
953
 
    checker_command = notifychangeproperty(dbus.String, "Checker")
954
 
    
955
 
    del notifychangeproperty
956
 
    
957
 
    def __del__(self, *args, **kwargs):
958
 
        try:
959
 
            self.remove_from_connection()
960
 
        except LookupError:
961
 
            pass
962
 
        if hasattr(DBusObjectWithProperties, "__del__"):
963
 
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
964
 
        Client.__del__(self, *args, **kwargs)
965
 
    
966
 
    def checker_callback(self, pid, condition, command,
967
 
                         *args, **kwargs):
968
 
        self.checker_callback_tag = None
969
 
        self.checker = None
970
 
        if os.WIFEXITED(condition):
971
 
            exitstatus = os.WEXITSTATUS(condition)
972
 
            # Emit D-Bus signal
973
 
            self.CheckerCompleted(dbus.Int16(exitstatus),
974
 
                                  dbus.Int64(condition),
975
 
                                  dbus.String(command))
976
 
        else:
977
 
            # Emit D-Bus signal
978
 
            self.CheckerCompleted(dbus.Int16(-1),
979
 
                                  dbus.Int64(condition),
980
 
                                  dbus.String(command))
981
 
        
982
 
        return Client.checker_callback(self, pid, condition, command,
983
 
                                       *args, **kwargs)
984
 
    
985
 
    def start_checker(self, *args, **kwargs):
986
 
        old_checker = self.checker
987
 
        if self.checker is not None:
988
 
            old_checker_pid = self.checker.pid
989
 
        else:
990
 
            old_checker_pid = None
991
 
        r = Client.start_checker(self, *args, **kwargs)
992
 
        # Only if new checker process was started
993
 
        if (self.checker is not None
994
 
            and old_checker_pid != self.checker.pid):
995
 
            # Emit D-Bus signal
996
 
            self.CheckerStarted(self.current_checker_command)
997
 
        return r
998
 
    
999
 
    def _reset_approved(self):
1000
 
        self._approved = None
1001
 
        return False
1002
 
    
1003
 
    def approve(self, value=True):
1004
 
        self.send_changedstate()
1005
 
        self._approved = value
1006
 
        gobject.timeout_add(_timedelta_to_milliseconds
1007
 
                            (self.approval_duration),
1008
 
                            self._reset_approved)
1009
 
    
1010
 
    
1011
 
    ## D-Bus methods, signals & properties
1012
 
    _interface = "se.recompile.Mandos.Client"
1013
 
    
1014
 
    ## Signals
1015
 
    
1016
 
    # CheckerCompleted - signal
1017
 
    @dbus.service.signal(_interface, signature="nxs")
1018
 
    def CheckerCompleted(self, exitcode, waitstatus, command):
1019
 
        "D-Bus signal"
1020
 
        pass
1021
 
    
1022
 
    # CheckerStarted - signal
1023
 
    @dbus.service.signal(_interface, signature="s")
1024
 
    def CheckerStarted(self, command):
1025
 
        "D-Bus signal"
1026
 
        pass
1027
 
    
1028
 
    # PropertyChanged - signal
1029
 
    @dbus.service.signal(_interface, signature="sv")
1030
 
    def PropertyChanged(self, property, value):
1031
 
        "D-Bus signal"
1032
 
        pass
1033
 
    
1034
 
    # GotSecret - signal
1035
 
    @dbus.service.signal(_interface)
1036
 
    def GotSecret(self):
1037
 
        """D-Bus signal
1038
 
        Is sent after a successful transfer of secret from the Mandos
1039
 
        server to mandos-client
1040
 
        """
1041
 
        pass
1042
 
    
1043
 
    # Rejected - signal
1044
 
    @dbus.service.signal(_interface, signature="s")
1045
 
    def Rejected(self, reason):
1046
 
        "D-Bus signal"
1047
 
        pass
1048
 
    
1049
 
    # NeedApproval - signal
1050
 
    @dbus.service.signal(_interface, signature="tb")
1051
 
    def NeedApproval(self, timeout, default):
1052
 
        "D-Bus signal"
1053
 
        return self.need_approval()
1054
 
    
1055
 
    ## Methods
1056
 
    
1057
 
    # Approve - method
1058
 
    @dbus.service.method(_interface, in_signature="b")
1059
 
    def Approve(self, value):
1060
 
        self.approve(value)
1061
 
    
1062
 
    # CheckedOK - method
1063
 
    @dbus.service.method(_interface)
1064
 
    def CheckedOK(self):
1065
 
        self.checked_ok()
1066
 
    
1067
 
    # Enable - method
1068
 
    @dbus.service.method(_interface)
1069
 
    def Enable(self):
1070
 
        "D-Bus method"
1071
 
        self.enable()
1072
 
    
1073
 
    # StartChecker - method
1074
 
    @dbus.service.method(_interface)
1075
 
    def StartChecker(self):
1076
 
        "D-Bus method"
1077
 
        self.start_checker()
1078
 
    
1079
 
    # Disable - method
1080
 
    @dbus.service.method(_interface)
1081
 
    def Disable(self):
1082
 
        "D-Bus method"
1083
 
        self.disable()
1084
 
    
1085
 
    # StopChecker - method
1086
 
    @dbus.service.method(_interface)
1087
 
    def StopChecker(self):
1088
 
        self.stop_checker()
1089
 
    
1090
 
    ## Properties
1091
 
    
1092
 
    # ApprovalPending - property
1093
 
    @dbus_service_property(_interface, signature="b", access="read")
1094
 
    def ApprovalPending_dbus_property(self):
1095
 
        return dbus.Boolean(bool(self.approvals_pending))
1096
 
    
1097
 
    # ApprovedByDefault - property
1098
 
    @dbus_service_property(_interface, signature="b",
1099
 
                           access="readwrite")
1100
 
    def ApprovedByDefault_dbus_property(self, value=None):
1101
 
        if value is None:       # get
1102
 
            return dbus.Boolean(self.approved_by_default)
1103
 
        self.approved_by_default = bool(value)
1104
 
    
1105
 
    # ApprovalDelay - property
1106
 
    @dbus_service_property(_interface, signature="t",
1107
 
                           access="readwrite")
1108
 
    def ApprovalDelay_dbus_property(self, value=None):
1109
 
        if value is None:       # get
1110
 
            return dbus.UInt64(self.approval_delay_milliseconds())
1111
 
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1112
 
    
1113
 
    # ApprovalDuration - property
1114
 
    @dbus_service_property(_interface, signature="t",
1115
 
                           access="readwrite")
1116
 
    def ApprovalDuration_dbus_property(self, value=None):
1117
 
        if value is None:       # get
1118
 
            return dbus.UInt64(_timedelta_to_milliseconds(
1119
 
                    self.approval_duration))
1120
 
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1121
 
    
1122
 
    # Name - property
1123
 
    @dbus_service_property(_interface, signature="s", access="read")
1124
 
    def Name_dbus_property(self):
1125
 
        return dbus.String(self.name)
1126
 
    
1127
 
    # Fingerprint - property
1128
 
    @dbus_service_property(_interface, signature="s", access="read")
1129
 
    def Fingerprint_dbus_property(self):
1130
 
        return dbus.String(self.fingerprint)
1131
 
    
1132
 
    # Host - property
1133
 
    @dbus_service_property(_interface, signature="s",
1134
 
                           access="readwrite")
1135
 
    def Host_dbus_property(self, value=None):
1136
 
        if value is None:       # get
1137
 
            return dbus.String(self.host)
1138
 
        self.host = value
1139
 
    
1140
 
    # Created - property
1141
 
    @dbus_service_property(_interface, signature="s", access="read")
1142
 
    def Created_dbus_property(self):
1143
 
        return dbus.String(datetime_to_dbus(self.created))
1144
 
    
1145
 
    # LastEnabled - property
1146
 
    @dbus_service_property(_interface, signature="s", access="read")
1147
 
    def LastEnabled_dbus_property(self):
1148
 
        return datetime_to_dbus(self.last_enabled)
1149
 
    
1150
 
    # Enabled - property
1151
 
    @dbus_service_property(_interface, signature="b",
1152
 
                           access="readwrite")
1153
 
    def Enabled_dbus_property(self, value=None):
1154
 
        if value is None:       # get
1155
 
            return dbus.Boolean(self.enabled)
1156
 
        if value:
1157
 
            self.enable()
1158
 
        else:
1159
 
            self.disable()
1160
 
    
1161
 
    # LastCheckedOK - property
1162
 
    @dbus_service_property(_interface, signature="s",
1163
 
                           access="readwrite")
1164
 
    def LastCheckedOK_dbus_property(self, value=None):
1165
 
        if value is not None:
1166
 
            self.checked_ok()
1167
 
            return
1168
 
        return datetime_to_dbus(self.last_checked_ok)
1169
 
    
1170
 
    # Expires - property
1171
 
    @dbus_service_property(_interface, signature="s", access="read")
1172
 
    def Expires_dbus_property(self):
1173
 
        return datetime_to_dbus(self.expires)
1174
 
    
1175
 
    # LastApprovalRequest - property
1176
 
    @dbus_service_property(_interface, signature="s", access="read")
1177
 
    def LastApprovalRequest_dbus_property(self):
1178
 
        return datetime_to_dbus(self.last_approval_request)
1179
 
    
1180
 
    # Timeout - property
1181
 
    @dbus_service_property(_interface, signature="t",
1182
 
                           access="readwrite")
1183
 
    def Timeout_dbus_property(self, value=None):
1184
 
        if value is None:       # get
1185
 
            return dbus.UInt64(self.timeout_milliseconds())
1186
 
        self.timeout = datetime.timedelta(0, 0, 0, value)
1187
 
        if getattr(self, "disable_initiator_tag", None) is None:
1188
 
            return
1189
 
        # Reschedule timeout
1190
 
        gobject.source_remove(self.disable_initiator_tag)
1191
 
        self.disable_initiator_tag = None
1192
 
        self.expires = None
1193
 
        time_to_die = _timedelta_to_milliseconds((self
1194
 
                                                  .last_checked_ok
1195
 
                                                  + self.timeout)
1196
 
                                                 - datetime.datetime
1197
 
                                                 .utcnow())
1198
 
        if time_to_die <= 0:
1199
 
            # The timeout has passed
1200
 
            self.disable()
1201
 
        else:
1202
 
            self.expires = (datetime.datetime.utcnow()
1203
 
                            + datetime.timedelta(milliseconds =
1204
 
                                                 time_to_die))
1205
 
            self.disable_initiator_tag = (gobject.timeout_add
1206
 
                                          (time_to_die, self.disable))
1207
 
    
1208
 
    # ExtendedTimeout - property
1209
 
    @dbus_service_property(_interface, signature="t",
1210
 
                           access="readwrite")
1211
 
    def ExtendedTimeout_dbus_property(self, value=None):
1212
 
        if value is None:       # get
1213
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
1214
 
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1215
 
    
1216
 
    # Interval - property
1217
 
    @dbus_service_property(_interface, signature="t",
1218
 
                           access="readwrite")
1219
 
    def Interval_dbus_property(self, value=None):
1220
 
        if value is None:       # get
1221
 
            return dbus.UInt64(self.interval_milliseconds())
1222
 
        self.interval = datetime.timedelta(0, 0, 0, value)
1223
 
        if getattr(self, "checker_initiator_tag", None) is None:
1224
 
            return
1225
 
        # Reschedule checker run
1226
 
        gobject.source_remove(self.checker_initiator_tag)
1227
 
        self.checker_initiator_tag = (gobject.timeout_add
1228
 
                                      (value, self.start_checker))
1229
 
        self.start_checker()    # Start one now, too
1230
 
    
1231
 
    # Checker - property
1232
 
    @dbus_service_property(_interface, signature="s",
1233
 
                           access="readwrite")
1234
 
    def Checker_dbus_property(self, value=None):
1235
 
        if value is None:       # get
1236
 
            return dbus.String(self.checker_command)
1237
 
        self.checker_command = value
1238
 
    
1239
 
    # CheckerRunning - property
1240
 
    @dbus_service_property(_interface, signature="b",
1241
 
                           access="readwrite")
1242
 
    def CheckerRunning_dbus_property(self, value=None):
1243
 
        if value is None:       # get
1244
 
            return dbus.Boolean(self.checker is not None)
1245
 
        if value:
1246
 
            self.start_checker()
1247
 
        else:
1248
 
            self.stop_checker()
1249
 
    
1250
 
    # ObjectPath - property
1251
 
    @dbus_service_property(_interface, signature="o", access="read")
1252
 
    def ObjectPath_dbus_property(self):
1253
 
        return self.dbus_object_path # is already a dbus.ObjectPath
1254
 
    
1255
 
    # Secret = property
1256
 
    @dbus_service_property(_interface, signature="ay",
1257
 
                           access="write", byte_arrays=True)
1258
 
    def Secret_dbus_property(self, value):
1259
 
        self.secret = str(value)
1260
 
    
1261
 
    del _interface
1262
 
 
1263
 
 
1264
 
class ProxyClient(object):
1265
 
    def __init__(self, child_pipe, fpr, address):
1266
 
        self._pipe = child_pipe
1267
 
        self._pipe.send(('init', fpr, address))
1268
 
        if not self._pipe.recv():
1269
 
            raise KeyError()
1270
 
    
1271
 
    def __getattribute__(self, name):
1272
 
        if(name == '_pipe'):
1273
 
            return super(ProxyClient, self).__getattribute__(name)
1274
 
        self._pipe.send(('getattr', name))
1275
 
        data = self._pipe.recv()
1276
 
        if data[0] == 'data':
1277
 
            return data[1]
1278
 
        if data[0] == 'function':
1279
 
            def func(*args, **kwargs):
1280
 
                self._pipe.send(('funcall', name, args, kwargs))
1281
 
                return self._pipe.recv()[1]
1282
 
            return func
1283
 
    
1284
 
    def __setattr__(self, name, value):
1285
 
        if(name == '_pipe'):
1286
 
            return super(ProxyClient, self).__setattr__(name, value)
1287
 
        self._pipe.send(('setattr', name, value))
1288
 
 
1289
 
class ClientDBusTransitional(ClientDBus):
1290
 
    __metaclass__ = AlternateDBusNamesMetaclass
1291
 
 
1292
 
class ClientHandler(socketserver.BaseRequestHandler, object):
1293
 
    """A class to handle client connections.
1294
 
    
1295
 
    Instantiated once for each connection to handle it.
 
303
    def still_valid(self, now=None):
 
304
        """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:
 
308
            return now < (self.created + self.timeout)
 
309
        else:
 
310
            return now < (self.last_seen + self.timeout)
 
311
 
 
312
 
 
313
def peer_certificate(session):
 
314
    "Return the peer's OpenPGP certificate as a bytestring"
 
315
    # 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:
 
319
        # ...do the normal thing
 
320
        return session.peer_certificate
 
321
    list_size = ctypes.c_uint()
 
322
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
323
        (session._c_object, ctypes.byref(list_size))
 
324
    if list_size.value == 0:
 
325
        return None
 
326
    cert = cert_list[0]
 
327
    return ctypes.string_at(cert.data, cert.size)
 
328
 
 
329
 
 
330
def fingerprint(openpgp):
 
331
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
332
    # New empty GnuTLS certificate
 
333
    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)))
 
341
    # 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)
 
346
    # New buffer for the fingerprint
 
347
    buffer = ctypes.create_string_buffer(20)
 
348
    buffer_length = ctypes.c_size_t()
 
349
    # 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))
 
352
    # Deinit the certificate
 
353
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
354
    # Convert the buffer to a Python bytestring
 
355
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
356
    # Convert the bytestring to hexadecimal notation
 
357
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
358
    return hex_fpr
 
359
 
 
360
 
 
361
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
362
    """A TCP request handler class.
 
363
    Instantiated by IPv6_TCPServer for each request to handle it.
1296
364
    Note: This will run in its own forked process."""
1297
365
    
1298
366
    def handle(self):
1299
 
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1300
 
            logger.info("TCP connection from: %s",
1301
 
                        unicode(self.client_address))
1302
 
            logger.debug("Pipe FD: %d",
1303
 
                         self.server.child_pipe.fileno())
1304
 
            
1305
 
            session = (gnutls.connection
1306
 
                       .ClientSession(self.request,
1307
 
                                      gnutls.connection
1308
 
                                      .X509Credentials()))
1309
 
            
1310
 
            # Note: gnutls.connection.X509Credentials is really a
1311
 
            # generic GnuTLS certificate credentials object so long as
1312
 
            # no X.509 keys are added to it.  Therefore, we can use it
1313
 
            # here despite using OpenPGP certificates.
1314
 
            
1315
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1316
 
            #                      "+AES-256-CBC", "+SHA1",
1317
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1318
 
            #                      "+DHE-DSS"))
1319
 
            # Use a fallback default, since this MUST be set.
1320
 
            priority = self.server.gnutls_priority
1321
 
            if priority is None:
1322
 
                priority = "NORMAL"
1323
 
            (gnutls.library.functions
1324
 
             .gnutls_priority_set_direct(session._c_object,
1325
 
                                         priority, None))
1326
 
            
1327
 
            # Start communication using the Mandos protocol
1328
 
            # Get protocol number
1329
 
            line = self.request.makefile().readline()
1330
 
            logger.debug("Protocol version: %r", line)
1331
 
            try:
1332
 
                if int(line.strip().split()[0]) > 1:
1333
 
                    raise RuntimeError
1334
 
            except (ValueError, IndexError, RuntimeError) as error:
1335
 
                logger.error("Unknown protocol version: %s", error)
1336
 
                return
1337
 
            
1338
 
            # Start GnuTLS connection
1339
 
            try:
1340
 
                session.handshake()
1341
 
            except gnutls.errors.GNUTLSError as error:
1342
 
                logger.warning("Handshake failed: %s", error)
1343
 
                # Do not run session.bye() here: the session is not
1344
 
                # established.  Just abandon the request.
1345
 
                return
1346
 
            logger.debug("Handshake succeeded")
1347
 
            
1348
 
            approval_required = False
1349
 
            try:
1350
 
                try:
1351
 
                    fpr = self.fingerprint(self.peer_certificate
1352
 
                                           (session))
1353
 
                except (TypeError,
1354
 
                        gnutls.errors.GNUTLSError) as error:
1355
 
                    logger.warning("Bad certificate: %s", error)
1356
 
                    return
1357
 
                logger.debug("Fingerprint: %s", fpr)
1358
 
                
1359
 
                try:
1360
 
                    client = ProxyClient(child_pipe, fpr,
1361
 
                                         self.client_address)
1362
 
                except KeyError:
1363
 
                    return
1364
 
                
1365
 
                if client.approval_delay:
1366
 
                    delay = client.approval_delay
1367
 
                    client.approvals_pending += 1
1368
 
                    approval_required = True
1369
 
                
1370
 
                while True:
1371
 
                    if not client.enabled:
1372
 
                        logger.info("Client %s is disabled",
1373
 
                                       client.name)
1374
 
                        if self.server.use_dbus:
1375
 
                            # Emit D-Bus signal
1376
 
                            client.Rejected("Disabled")
1377
 
                        return
1378
 
                    
1379
 
                    if client._approved or not client.approval_delay:
1380
 
                        #We are approved or approval is disabled
1381
 
                        break
1382
 
                    elif client._approved is None:
1383
 
                        logger.info("Client %s needs approval",
1384
 
                                    client.name)
1385
 
                        if self.server.use_dbus:
1386
 
                            # Emit D-Bus signal
1387
 
                            client.NeedApproval(
1388
 
                                client.approval_delay_milliseconds(),
1389
 
                                client.approved_by_default)
1390
 
                    else:
1391
 
                        logger.warning("Client %s was not approved",
1392
 
                                       client.name)
1393
 
                        if self.server.use_dbus:
1394
 
                            # Emit D-Bus signal
1395
 
                            client.Rejected("Denied")
1396
 
                        return
1397
 
                    
1398
 
                    #wait until timeout or approved
1399
 
                    time = datetime.datetime.now()
1400
 
                    client.changedstate.acquire()
1401
 
                    (client.changedstate.wait
1402
 
                     (float(client._timedelta_to_milliseconds(delay)
1403
 
                            / 1000)))
1404
 
                    client.changedstate.release()
1405
 
                    time2 = datetime.datetime.now()
1406
 
                    if (time2 - time) >= delay:
1407
 
                        if not client.approved_by_default:
1408
 
                            logger.warning("Client %s timed out while"
1409
 
                                           " waiting for approval",
1410
 
                                           client.name)
1411
 
                            if self.server.use_dbus:
1412
 
                                # Emit D-Bus signal
1413
 
                                client.Rejected("Approval timed out")
1414
 
                            return
1415
 
                        else:
1416
 
                            break
1417
 
                    else:
1418
 
                        delay -= time2 - time
1419
 
                
1420
 
                sent_size = 0
1421
 
                while sent_size < len(client.secret):
1422
 
                    try:
1423
 
                        sent = session.send(client.secret[sent_size:])
1424
 
                    except gnutls.errors.GNUTLSError as error:
1425
 
                        logger.warning("gnutls send failed")
1426
 
                        return
1427
 
                    logger.debug("Sent: %d, remaining: %d",
1428
 
                                 sent, len(client.secret)
1429
 
                                 - (sent_size + sent))
1430
 
                    sent_size += sent
1431
 
                
1432
 
                logger.info("Sending secret to %s", client.name)
1433
 
                # bump the timeout using extended_timeout
1434
 
                client.checked_ok(client.extended_timeout)
1435
 
                if self.server.use_dbus:
1436
 
                    # Emit D-Bus signal
1437
 
                    client.GotSecret()
1438
 
            
1439
 
            finally:
1440
 
                if approval_required:
1441
 
                    client.approvals_pending -= 1
1442
 
                try:
1443
 
                    session.bye()
1444
 
                except gnutls.errors.GNUTLSError as error:
1445
 
                    logger.warning("GnuTLS bye failed")
1446
 
    
1447
 
    @staticmethod
1448
 
    def peer_certificate(session):
1449
 
        "Return the peer's OpenPGP certificate as a bytestring"
1450
 
        # If not an OpenPGP certificate...
1451
 
        if (gnutls.library.functions
1452
 
            .gnutls_certificate_type_get(session._c_object)
1453
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1454
 
            # ...do the normal thing
1455
 
            return session.peer_certificate
1456
 
        list_size = ctypes.c_uint(1)
1457
 
        cert_list = (gnutls.library.functions
1458
 
                     .gnutls_certificate_get_peers
1459
 
                     (session._c_object, ctypes.byref(list_size)))
1460
 
        if not bool(cert_list) and list_size.value != 0:
1461
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1462
 
                                            " certificate")
1463
 
        if list_size.value == 0:
1464
 
            return None
1465
 
        cert = cert_list[0]
1466
 
        return ctypes.string_at(cert.data, cert.size)
1467
 
    
1468
 
    @staticmethod
1469
 
    def fingerprint(openpgp):
1470
 
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1471
 
        # New GnuTLS "datum" with the OpenPGP public key
1472
 
        datum = (gnutls.library.types
1473
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1474
 
                                             ctypes.POINTER
1475
 
                                             (ctypes.c_ubyte)),
1476
 
                                 ctypes.c_uint(len(openpgp))))
1477
 
        # New empty GnuTLS certificate
1478
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1479
 
        (gnutls.library.functions
1480
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
1481
 
        # Import the OpenPGP public key into the certificate
1482
 
        (gnutls.library.functions
1483
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1484
 
                                    gnutls.library.constants
1485
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
1486
 
        # Verify the self signature in the key
1487
 
        crtverify = ctypes.c_uint()
1488
 
        (gnutls.library.functions
1489
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1490
 
                                         ctypes.byref(crtverify)))
1491
 
        if crtverify.value != 0:
1492
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1493
 
            raise (gnutls.errors.CertificateSecurityError
1494
 
                   ("Verify failed"))
1495
 
        # New buffer for the fingerprint
1496
 
        buf = ctypes.create_string_buffer(20)
1497
 
        buf_len = ctypes.c_size_t()
1498
 
        # Get the fingerprint from the certificate into the buffer
1499
 
        (gnutls.library.functions
1500
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1501
 
                                             ctypes.byref(buf_len)))
1502
 
        # Deinit the certificate
1503
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1504
 
        # Convert the buffer to a Python bytestring
1505
 
        fpr = ctypes.string_at(buf, buf_len.value)
1506
 
        # Convert the bytestring to hexadecimal notation
1507
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1508
 
        return hex_fpr
1509
 
 
1510
 
 
1511
 
class MultiprocessingMixIn(object):
1512
 
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
1513
 
    def sub_process_main(self, request, address):
1514
 
        try:
1515
 
            self.finish_request(request, address)
1516
 
        except:
1517
 
            self.handle_error(request, address)
1518
 
        self.close_request(request)
1519
 
    
1520
 
    def process_request(self, request, address):
1521
 
        """Start a new process to process the request."""
1522
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1523
 
                                       args = (request,
1524
 
                                               address))
1525
 
        proc.start()
1526
 
        return proc
1527
 
 
1528
 
 
1529
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1530
 
    """ adds a pipe to the MixIn """
1531
 
    def process_request(self, request, client_address):
1532
 
        """Overrides and wraps the original process_request().
1533
 
        
1534
 
        This function creates a new pipe in self.pipe
1535
 
        """
1536
 
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1537
 
        
1538
 
        proc = MultiprocessingMixIn.process_request(self, request,
1539
 
                                                    client_address)
1540
 
        self.child_pipe.close()
1541
 
        self.add_pipe(parent_pipe, proc)
1542
 
    
1543
 
    def add_pipe(self, parent_pipe, proc):
1544
 
        """Dummy function; override as necessary"""
1545
 
        raise NotImplementedError
1546
 
 
1547
 
 
1548
 
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1549
 
                     socketserver.TCPServer, object):
1550
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1551
 
    
 
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())
 
372
        
 
373
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
 
374
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
375
        #                "+DHE-DSS"))
 
376
        priority = "NORMAL"
 
377
        if self.server.options.priority:
 
378
            priority = self.server.options.priority
 
379
        gnutls.library.functions.gnutls_priority_set_direct\
 
380
            (session._c_object, priority, None);
 
381
        
 
382
        try:
 
383
            session.handshake()
 
384
        except gnutls.errors.GNUTLSError, error:
 
385
            logger.debug(u"Handshake failed: %s", error)
 
386
            # Do not run session.bye() here: the session is not
 
387
            # established.  Just abandon the request.
 
388
            return
 
389
        try:
 
390
            fpr = fingerprint(peer_certificate(session))
 
391
        except (TypeError, gnutls.errors.GNUTLSError), error:
 
392
            logger.debug(u"Bad certificate: %s", error)
 
393
            session.bye()
 
394
            return
 
395
        logger.debug(u"Fingerprint: %s", fpr)
 
396
        client = None
 
397
        for c in self.server.clients:
 
398
            if c.fingerprint == fpr:
 
399
                client = c
 
400
                break
 
401
        # Have to check if client.still_valid(), since it is possible
 
402
        # that the client timed out while establishing the GnuTLS
 
403
        # 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)
 
411
            session.bye()
 
412
            return
 
413
        sent_size = 0
 
414
        while sent_size < len(client.secret):
 
415
            sent = session.send(client.secret[sent_size:])
 
416
            logger.debug(u"Sent: %d, remaining: %d",
 
417
                         sent, len(client.secret)
 
418
                         - (sent_size + sent))
 
419
            sent_size += sent
 
420
        session.bye()
 
421
 
 
422
 
 
423
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
424
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
1552
425
    Attributes:
1553
 
        enabled:        Boolean; whether this server is activated yet
1554
 
        interface:      None or a network interface name (string)
1555
 
        use_ipv6:       Boolean; to use IPv6 or not
 
426
        options:        Command line options
 
427
        clients:        Set() of Client objects
1556
428
    """
1557
 
    def __init__(self, server_address, RequestHandlerClass,
1558
 
                 interface=None, use_ipv6=True):
1559
 
        self.interface = interface
1560
 
        if use_ipv6:
1561
 
            self.address_family = socket.AF_INET6
1562
 
        socketserver.TCPServer.__init__(self, server_address,
1563
 
                                        RequestHandlerClass)
 
429
    address_family = socket.AF_INET6
 
430
    def __init__(self, *args, **kwargs):
 
431
        if "options" in kwargs:
 
432
            self.options = kwargs["options"]
 
433
            del kwargs["options"]
 
434
        if "clients" in kwargs:
 
435
            self.clients = kwargs["clients"]
 
436
            del kwargs["clients"]
 
437
        return super(type(self), self).__init__(*args, **kwargs)
1564
438
    def server_bind(self):
1565
439
        """This overrides the normal server_bind() function
1566
440
        to bind to an interface if one was specified, and also NOT to
1567
441
        bind to an address or port if they were not specified."""
1568
 
        if self.interface is not None:
1569
 
            if SO_BINDTODEVICE is None:
1570
 
                logger.error("SO_BINDTODEVICE does not exist;"
1571
 
                             " cannot bind to interface %s",
1572
 
                             self.interface)
1573
 
            else:
1574
 
                try:
1575
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1576
 
                                           SO_BINDTODEVICE,
1577
 
                                           str(self.interface
1578
 
                                               + '\0'))
1579
 
                except socket.error as error:
1580
 
                    if error[0] == errno.EPERM:
1581
 
                        logger.error("No permission to"
1582
 
                                     " bind to interface %s",
1583
 
                                     self.interface)
1584
 
                    elif error[0] == errno.ENOPROTOOPT:
1585
 
                        logger.error("SO_BINDTODEVICE not available;"
1586
 
                                     " cannot bind to interface %s",
1587
 
                                     self.interface)
1588
 
                    else:
1589
 
                        raise
 
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
 
446
            try:
 
447
                self.socket.setsockopt(socket.SOL_SOCKET,
 
448
                                       socket.SO_BINDTODEVICE,
 
449
                                       self.options.interface)
 
450
            except socket.error, error:
 
451
                if error[0] == errno.EPERM:
 
452
                    logger.warning(u"No permission to"
 
453
                                   u" bind to interface %s",
 
454
                                   self.options.interface)
 
455
                else:
 
456
                    raise error
1590
457
        # Only bind(2) the socket if we really need to.
1591
458
        if self.server_address[0] or self.server_address[1]:
1592
459
            if not self.server_address[0]:
1593
 
                if self.address_family == socket.AF_INET6:
1594
 
                    any_address = "::" # in6addr_any
1595
 
                else:
1596
 
                    any_address = socket.INADDR_ANY
1597
 
                self.server_address = (any_address,
 
460
                in6addr_any = "::"
 
461
                self.server_address = (in6addr_any,
1598
462
                                       self.server_address[1])
1599
 
            elif not self.server_address[1]:
 
463
            elif self.server_address[1] is None:
1600
464
                self.server_address = (self.server_address[0],
1601
465
                                       0)
1602
 
#                 if self.interface:
1603
 
#                     self.server_address = (self.server_address[0],
1604
 
#                                            0, # port
1605
 
#                                            0, # flowinfo
1606
 
#                                            if_nametoindex
1607
 
#                                            (self.interface))
1608
 
            return socketserver.TCPServer.server_bind(self)
1609
 
 
1610
 
 
1611
 
class MandosServer(IPv6_TCPServer):
1612
 
    """Mandos server.
1613
 
    
1614
 
    Attributes:
1615
 
        clients:        set of Client objects
1616
 
        gnutls_priority GnuTLS priority string
1617
 
        use_dbus:       Boolean; to emit D-Bus signals or not
1618
 
    
1619
 
    Assumes a gobject.MainLoop event loop.
1620
 
    """
1621
 
    def __init__(self, server_address, RequestHandlerClass,
1622
 
                 interface=None, use_ipv6=True, clients=None,
1623
 
                 gnutls_priority=None, use_dbus=True):
1624
 
        self.enabled = False
1625
 
        self.clients = clients
1626
 
        if self.clients is None:
1627
 
            self.clients = set()
1628
 
        self.use_dbus = use_dbus
1629
 
        self.gnutls_priority = gnutls_priority
1630
 
        IPv6_TCPServer.__init__(self, server_address,
1631
 
                                RequestHandlerClass,
1632
 
                                interface = interface,
1633
 
                                use_ipv6 = use_ipv6)
1634
 
    def server_activate(self):
1635
 
        if self.enabled:
1636
 
            return socketserver.TCPServer.server_activate(self)
1637
 
    
1638
 
    def enable(self):
1639
 
        self.enabled = True
1640
 
    
1641
 
    def add_pipe(self, parent_pipe, proc):
1642
 
        # Call "handle_ipc" for both data and EOF events
1643
 
        gobject.io_add_watch(parent_pipe.fileno(),
1644
 
                             gobject.IO_IN | gobject.IO_HUP,
1645
 
                             functools.partial(self.handle_ipc,
1646
 
                                               parent_pipe =
1647
 
                                               parent_pipe,
1648
 
                                               proc = proc))
1649
 
    
1650
 
    def handle_ipc(self, source, condition, parent_pipe=None,
1651
 
                   proc = None, client_object=None):
1652
 
        condition_names = {
1653
 
            gobject.IO_IN: "IN",   # There is data to read.
1654
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1655
 
                                    # blocking).
1656
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1657
 
            gobject.IO_ERR: "ERR", # Error condition.
1658
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1659
 
                                    # broken, usually for pipes and
1660
 
                                    # sockets).
1661
 
            }
1662
 
        conditions_string = ' | '.join(name
1663
 
                                       for cond, name in
1664
 
                                       condition_names.iteritems()
1665
 
                                       if cond & condition)
1666
 
        # error, or the other end of multiprocessing.Pipe has closed
1667
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1668
 
            # Wait for other process to exit
1669
 
            proc.join()
1670
 
            return False
1671
 
        
1672
 
        # Read a request from the child
1673
 
        request = parent_pipe.recv()
1674
 
        command = request[0]
1675
 
        
1676
 
        if command == 'init':
1677
 
            fpr = request[1]
1678
 
            address = request[2]
1679
 
            
1680
 
            for c in self.clients:
1681
 
                if c.fingerprint == fpr:
1682
 
                    client = c
1683
 
                    break
1684
 
            else:
1685
 
                logger.info("Client not found for fingerprint: %s, ad"
1686
 
                            "dress: %s", fpr, address)
1687
 
                if self.use_dbus:
1688
 
                    # Emit D-Bus signal
1689
 
                    mandos_dbus_service.ClientNotFound(fpr,
1690
 
                                                       address[0])
1691
 
                parent_pipe.send(False)
1692
 
                return False
1693
 
            
1694
 
            gobject.io_add_watch(parent_pipe.fileno(),
1695
 
                                 gobject.IO_IN | gobject.IO_HUP,
1696
 
                                 functools.partial(self.handle_ipc,
1697
 
                                                   parent_pipe =
1698
 
                                                   parent_pipe,
1699
 
                                                   proc = proc,
1700
 
                                                   client_object =
1701
 
                                                   client))
1702
 
            parent_pipe.send(True)
1703
 
            # remove the old hook in favor of the new above hook on
1704
 
            # same fileno
1705
 
            return False
1706
 
        if command == 'funcall':
1707
 
            funcname = request[1]
1708
 
            args = request[2]
1709
 
            kwargs = request[3]
1710
 
            
1711
 
            parent_pipe.send(('data', getattr(client_object,
1712
 
                                              funcname)(*args,
1713
 
                                                         **kwargs)))
1714
 
        
1715
 
        if command == 'getattr':
1716
 
            attrname = request[1]
1717
 
            if callable(client_object.__getattribute__(attrname)):
1718
 
                parent_pipe.send(('function',))
1719
 
            else:
1720
 
                parent_pipe.send(('data', client_object
1721
 
                                  .__getattribute__(attrname)))
1722
 
        
1723
 
        if command == 'setattr':
1724
 
            attrname = request[1]
1725
 
            value = request[2]
1726
 
            setattr(client_object, attrname, value)
1727
 
        
1728
 
        return True
 
466
            return super(type(self), self).server_bind()
1729
467
 
1730
468
 
1731
469
def string_to_delta(interval):
1732
470
    """Parse a string and return a datetime.timedelta
1733
 
    
 
471
 
1734
472
    >>> string_to_delta('7d')
1735
473
    datetime.timedelta(7)
1736
474
    >>> string_to_delta('60s')
1739
477
    datetime.timedelta(0, 3600)
1740
478
    >>> string_to_delta('24h')
1741
479
    datetime.timedelta(1)
1742
 
    >>> string_to_delta('1w')
 
480
    >>> string_to_delta(u'1w')
1743
481
    datetime.timedelta(7)
1744
 
    >>> string_to_delta('5m 30s')
1745
 
    datetime.timedelta(0, 330)
1746
482
    """
1747
 
    timevalue = datetime.timedelta(0)
1748
 
    for s in interval.split():
1749
 
        try:
1750
 
            suffix = unicode(s[-1])
1751
 
            value = int(s[:-1])
1752
 
            if suffix == "d":
1753
 
                delta = datetime.timedelta(value)
1754
 
            elif suffix == "s":
1755
 
                delta = datetime.timedelta(0, value)
1756
 
            elif suffix == "m":
1757
 
                delta = datetime.timedelta(0, 0, 0, 0, value)
1758
 
            elif suffix == "h":
1759
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1760
 
            elif suffix == "w":
1761
 
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1762
 
            else:
1763
 
                raise ValueError("Unknown suffix %r" % suffix)
1764
 
        except (ValueError, IndexError) as e:
1765
 
            raise ValueError(*(e.args))
1766
 
        timevalue += delta
1767
 
    return timevalue
 
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:
 
497
            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()
 
534
 
 
535
 
 
536
def server_state_changed(state):
 
537
    """Derived from the Avahi example code"""
 
538
    if state == avahi.SERVER_COLLISION:
 
539
        logger.warning(u"Server name collision")
 
540
        remove_service()
 
541
    elif state == avahi.SERVER_RUNNING:
 
542
        add_service()
 
543
 
 
544
 
 
545
def entry_group_state_changed(state, error):
 
546
    """Derived from the Avahi example code"""
 
547
    global serviceName, server, rename_count
 
548
    
 
549
    logger.debug(u"state change: %i", state)
 
550
    
 
551
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
552
        logger.debug(u"Service established.")
 
553
    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)
 
567
    elif state == avahi.ENTRY_GROUP_FAILURE:
 
568
        logger.error(u"Error in group state changed %s",
 
569
                     unicode(error))
 
570
        killme(1)
1768
571
 
1769
572
 
1770
573
def if_nametoindex(interface):
1771
 
    """Call the C function if_nametoindex(), or equivalent
1772
 
    
1773
 
    Note: This function cannot accept a unicode string."""
1774
 
    global if_nametoindex
 
574
    """Call the C function if_nametoindex()"""
1775
575
    try:
1776
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1777
 
                          (ctypes.util.find_library("c"))
1778
 
                          .if_nametoindex)
 
576
        libc = ctypes.cdll.LoadLibrary("libc.so.6")
 
577
        return libc.if_nametoindex(interface)
1779
578
    except (OSError, AttributeError):
1780
 
        logger.warning("Doing if_nametoindex the hard way")
1781
 
        def if_nametoindex(interface):
1782
 
            "Get an interface index the hard way, i.e. using fcntl()"
1783
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1784
 
            with contextlib.closing(socket.socket()) as s:
1785
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1786
 
                                    struct.pack(str("16s16x"),
1787
 
                                                interface))
1788
 
            interface_index = struct.unpack(str("I"),
1789
 
                                            ifreq[16:20])[0]
1790
 
            return interface_index
1791
 
    return if_nametoindex(interface)
1792
 
 
1793
 
 
1794
 
def daemon(nochdir = False, noclose = False):
 
579
        if "struct" not in sys.modules:
 
580
            import struct
 
581
        if "fcntl" not in sys.modules:
 
582
            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):
1795
593
    """See daemon(3).  Standard BSD Unix function.
1796
 
    
1797
594
    This should really exist as os.daemon, but it doesn't (yet)."""
1798
595
    if os.fork():
1799
596
        sys.exit()
1800
597
    os.setsid()
1801
598
    if not nochdir:
1802
599
        os.chdir("/")
1803
 
    if os.fork():
1804
 
        sys.exit()
1805
600
    if not noclose:
1806
601
        # Close all standard open file descriptors
1807
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
602
        null = os.open("/dev/null", os.O_NOCTTY | os.O_RDWR)
1808
603
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1809
604
            raise OSError(errno.ENODEV,
1810
 
                          "%s not a character device"
1811
 
                          % os.path.devnull)
 
605
                          "/dev/null not a character device")
1812
606
        os.dup2(null, sys.stdin.fileno())
1813
607
        os.dup2(null, sys.stdout.fileno())
1814
608
        os.dup2(null, sys.stderr.fileno())
1816
610
            os.close(null)
1817
611
 
1818
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
 
1819
622
def main():
1820
 
    
1821
 
    ##################################################################
1822
 
    # Parsing of options, both command line and config file
1823
 
    
1824
 
    parser = argparse.ArgumentParser()
1825
 
    parser.add_argument("-v", "--version", action="version",
1826
 
                        version = "%%(prog)s %s" % version,
1827
 
                        help="show version number and exit")
1828
 
    parser.add_argument("-i", "--interface", metavar="IF",
1829
 
                        help="Bind to interface IF")
1830
 
    parser.add_argument("-a", "--address",
1831
 
                        help="Address to listen for requests on")
1832
 
    parser.add_argument("-p", "--port", type=int,
1833
 
                        help="Port number to receive requests on")
1834
 
    parser.add_argument("--check", action="store_true",
1835
 
                        help="Run self-test")
1836
 
    parser.add_argument("--debug", action="store_true",
1837
 
                        help="Debug mode; run in foreground and log"
1838
 
                        " to terminal")
1839
 
    parser.add_argument("--debuglevel", metavar="LEVEL",
1840
 
                        help="Debug level for stdout output")
1841
 
    parser.add_argument("--priority", help="GnuTLS"
1842
 
                        " priority string (see GnuTLS documentation)")
1843
 
    parser.add_argument("--servicename",
1844
 
                        metavar="NAME", help="Zeroconf service name")
1845
 
    parser.add_argument("--configdir",
1846
 
                        default="/etc/mandos", metavar="DIR",
1847
 
                        help="Directory to search for configuration"
1848
 
                        " files")
1849
 
    parser.add_argument("--no-dbus", action="store_false",
1850
 
                        dest="use_dbus", help="Do not provide D-Bus"
1851
 
                        " system bus interface")
1852
 
    parser.add_argument("--no-ipv6", action="store_false",
1853
 
                        dest="use_ipv6", help="Do not use IPv6")
1854
 
    options = parser.parse_args()
 
623
    global exitstatus
 
624
    exitstatus = 0
 
625
    global main_loop_started
 
626
    main_loop_started = False
 
627
    
 
628
    parser = OptionParser()
 
629
    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,
 
633
                      help="Address to listen for requests on")
 
634
    parser.add_option("-p", "--port", type="int", default=None,
 
635
                      help="Port number to receive requests on")
 
636
    parser.add_option("--check", action="store_true", default=False,
 
637
                      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()
1855
647
    
1856
648
    if options.check:
1857
649
        import doctest
1858
650
        doctest.testmod()
1859
651
        sys.exit()
1860
652
    
1861
 
    # Default values for config file for server-global settings
1862
 
    server_defaults = { "interface": "",
1863
 
                        "address": "",
1864
 
                        "port": "",
1865
 
                        "debug": "False",
1866
 
                        "priority":
1867
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1868
 
                        "servicename": "Mandos",
1869
 
                        "use_dbus": "True",
1870
 
                        "use_ipv6": "True",
1871
 
                        "debuglevel": "",
1872
 
                        }
1873
 
    
1874
 
    # Parse config file for server-global settings
1875
 
    server_config = configparser.SafeConfigParser(server_defaults)
1876
 
    del server_defaults
1877
 
    server_config.read(os.path.join(options.configdir,
1878
 
                                    "mandos.conf"))
1879
 
    # Convert the SafeConfigParser object to a dict
1880
 
    server_settings = server_config.defaults()
1881
 
    # Use the appropriate methods on the non-string config options
1882
 
    for option in ("debug", "use_dbus", "use_ipv6"):
1883
 
        server_settings[option] = server_config.getboolean("DEFAULT",
1884
 
                                                           option)
1885
 
    if server_settings["port"]:
1886
 
        server_settings["port"] = server_config.getint("DEFAULT",
1887
 
                                                       "port")
1888
 
    del server_config
1889
 
    
1890
 
    # Override the settings from the config file with command line
1891
 
    # options, if set.
1892
 
    for option in ("interface", "address", "port", "debug",
1893
 
                   "priority", "servicename", "configdir",
1894
 
                   "use_dbus", "use_ipv6", "debuglevel"):
1895
 
        value = getattr(options, option)
1896
 
        if value is not None:
1897
 
            server_settings[option] = value
1898
 
    del options
1899
 
    # Force all strings to be unicode
1900
 
    for option in server_settings.keys():
1901
 
        if type(server_settings[option]) is str:
1902
 
            server_settings[option] = unicode(server_settings[option])
1903
 
    # Now we have our good server settings in "server_settings"
1904
 
    
1905
 
    ##################################################################
1906
 
    
1907
 
    # For convenience
1908
 
    debug = server_settings["debug"]
1909
 
    debuglevel = server_settings["debuglevel"]
1910
 
    use_dbus = server_settings["use_dbus"]
1911
 
    use_ipv6 = server_settings["use_ipv6"]
1912
 
    
1913
 
    if server_settings["servicename"] != "Mandos":
1914
 
        syslogger.setFormatter(logging.Formatter
1915
 
                               ('Mandos (%s) [%%(process)d]:'
1916
 
                                ' %%(levelname)s: %%(message)s'
1917
 
                                % server_settings["servicename"]))
1918
 
    
1919
 
    # Parse config file with clients
1920
 
    client_defaults = { "timeout": "5m",
1921
 
                        "extended_timeout": "15m",
1922
 
                        "interval": "2m",
1923
 
                        "checker": "fping -q -- %%(host)s",
1924
 
                        "host": "",
1925
 
                        "approval_delay": "0s",
1926
 
                        "approval_duration": "1s",
1927
 
                        }
1928
 
    client_config = configparser.SafeConfigParser(client_defaults)
1929
 
    client_config.read(os.path.join(server_settings["configdir"],
1930
 
                                    "clients.conf"))
1931
 
    
1932
 
    global mandos_dbus_service
1933
 
    mandos_dbus_service = None
1934
 
    
1935
 
    tcp_server = MandosServer((server_settings["address"],
1936
 
                               server_settings["port"]),
1937
 
                              ClientHandler,
1938
 
                              interface=(server_settings["interface"]
1939
 
                                         or None),
1940
 
                              use_ipv6=use_ipv6,
1941
 
                              gnutls_priority=
1942
 
                              server_settings["priority"],
1943
 
                              use_dbus=use_dbus)
1944
 
    if not debug:
1945
 
        pidfilename = "/var/run/mandos.pid"
1946
 
        try:
1947
 
            pidfile = open(pidfilename, "w")
1948
 
        except IOError:
1949
 
            logger.error("Could not open file %r", pidfilename)
1950
 
    
1951
 
    try:
1952
 
        uid = pwd.getpwnam("_mandos").pw_uid
1953
 
        gid = pwd.getpwnam("_mandos").pw_gid
1954
 
    except KeyError:
1955
 
        try:
1956
 
            uid = pwd.getpwnam("mandos").pw_uid
1957
 
            gid = pwd.getpwnam("mandos").pw_gid
1958
 
        except KeyError:
1959
 
            try:
1960
 
                uid = pwd.getpwnam("nobody").pw_uid
1961
 
                gid = pwd.getpwnam("nobody").pw_gid
1962
 
            except KeyError:
1963
 
                uid = 65534
1964
 
                gid = 65534
1965
 
    try:
1966
 
        os.setgid(gid)
1967
 
        os.setuid(uid)
1968
 
    except OSError as error:
1969
 
        if error[0] != errno.EPERM:
1970
 
            raise error
1971
 
    
1972
 
    if not debug and not debuglevel:
1973
 
        syslogger.setLevel(logging.WARNING)
1974
 
        console.setLevel(logging.WARNING)
1975
 
    if debuglevel:
1976
 
        level = getattr(logging, debuglevel.upper())
1977
 
        syslogger.setLevel(level)
1978
 
        console.setLevel(level)
1979
 
    
1980
 
    if debug:
1981
 
        # Enable all possible GnuTLS debugging
1982
 
        
1983
 
        # "Use a log level over 10 to enable all debugging options."
1984
 
        # - GnuTLS manual
1985
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
1986
 
        
1987
 
        @gnutls.library.types.gnutls_log_func
1988
 
        def debug_gnutls(level, string):
1989
 
            logger.debug("GnuTLS: %s", string[:-1])
1990
 
        
1991
 
        (gnutls.library.functions
1992
 
         .gnutls_global_set_log_function(debug_gnutls))
1993
 
        
1994
 
        # Redirect stdin so all checkers get /dev/null
1995
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1996
 
        os.dup2(null, sys.stdin.fileno())
1997
 
        if null > 2:
1998
 
            os.close(null)
1999
 
    else:
2000
 
        # No console logging
2001
 
        logger.removeHandler(console)
2002
 
    
2003
 
    # Need to fork before connecting to D-Bus
2004
 
    if not debug:
2005
 
        # Close all input and output, do double fork, etc.
2006
 
        daemon()
 
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;
2007
664
    
2008
665
    global main_loop
 
666
    global bus
 
667
    global server
2009
668
    # From the Avahi example code
2010
669
    DBusGMainLoop(set_as_default=True )
2011
670
    main_loop = gobject.MainLoop()
2012
671
    bus = dbus.SystemBus()
 
672
    server = dbus.Interface(
 
673
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
674
            avahi.DBUS_INTERFACE_SERVER )
2013
675
    # End of Avahi example code
2014
 
    if use_dbus:
2015
 
        try:
2016
 
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2017
 
                                            bus, do_not_queue=True)
2018
 
            old_bus_name = (dbus.service.BusName
2019
 
                            ("se.bsnet.fukt.Mandos", bus,
2020
 
                             do_not_queue=True))
2021
 
        except dbus.exceptions.NameExistsException as e:
2022
 
            logger.error(unicode(e) + ", disabling D-Bus")
2023
 
            use_dbus = False
2024
 
            server_settings["use_dbus"] = False
2025
 
            tcp_server.use_dbus = False
2026
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2027
 
    service = AvahiService(name = server_settings["servicename"],
2028
 
                           servicetype = "_mandos._tcp",
2029
 
                           protocol = protocol, bus = bus)
2030
 
    if server_settings["interface"]:
2031
 
        service.interface = (if_nametoindex
2032
 
                             (str(server_settings["interface"])))
2033
 
    
2034
 
    global multiprocessing_manager
2035
 
    multiprocessing_manager = multiprocessing.Manager()
2036
 
    
2037
 
    client_class = Client
2038
 
    if use_dbus:
2039
 
        client_class = functools.partial(ClientDBusTransitional,
2040
 
                                         bus = bus)
2041
 
    def client_config_items(config, section):
2042
 
        special_settings = {
2043
 
            "approved_by_default":
2044
 
                lambda: config.getboolean(section,
2045
 
                                          "approved_by_default"),
2046
 
            }
2047
 
        for name, value in config.items(section):
2048
 
            try:
2049
 
                yield (name, special_settings[name]())
2050
 
            except KeyError:
2051
 
                yield (name, value)
2052
 
    
2053
 
    tcp_server.clients.update(set(
2054
 
            client_class(name = section,
2055
 
                         config= dict(client_config_items(
2056
 
                        client_config, section)))
2057
 
            for section in client_config.sections()))
2058
 
    if not tcp_server.clients:
2059
 
        logger.warning("No clients defined")
2060
 
        
 
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))))
 
698
                       for section in client_config.sections()))
 
699
    
2061
700
    if not debug:
2062
 
        try:
2063
 
            with pidfile:
2064
 
                pid = os.getpid()
2065
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2066
 
            del pidfile
2067
 
        except IOError:
2068
 
            logger.error("Could not write to file %r with PID %d",
2069
 
                         pidfilename, pid)
2070
 
        except NameError:
2071
 
            # "pidfile" was never created
2072
 
            pass
2073
 
        del pidfilename
2074
 
        
2075
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2076
 
    
2077
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2078
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2079
 
    
2080
 
    if use_dbus:
2081
 
        class MandosDBusService(dbus.service.Object):
2082
 
            """A D-Bus proxy object"""
2083
 
            def __init__(self):
2084
 
                dbus.service.Object.__init__(self, bus, "/")
2085
 
            _interface = "se.recompile.Mandos"
2086
 
            
2087
 
            @dbus.service.signal(_interface, signature="o")
2088
 
            def ClientAdded(self, objpath):
2089
 
                "D-Bus signal"
2090
 
                pass
2091
 
            
2092
 
            @dbus.service.signal(_interface, signature="ss")
2093
 
            def ClientNotFound(self, fingerprint, address):
2094
 
                "D-Bus signal"
2095
 
                pass
2096
 
            
2097
 
            @dbus.service.signal(_interface, signature="os")
2098
 
            def ClientRemoved(self, objpath, name):
2099
 
                "D-Bus signal"
2100
 
                pass
2101
 
            
2102
 
            @dbus.service.method(_interface, out_signature="ao")
2103
 
            def GetAllClients(self):
2104
 
                "D-Bus method"
2105
 
                return dbus.Array(c.dbus_object_path
2106
 
                                  for c in tcp_server.clients)
2107
 
            
2108
 
            @dbus.service.method(_interface,
2109
 
                                 out_signature="a{oa{sv}}")
2110
 
            def GetAllClientsWithProperties(self):
2111
 
                "D-Bus method"
2112
 
                return dbus.Dictionary(
2113
 
                    ((c.dbus_object_path, c.GetAll(""))
2114
 
                     for c in tcp_server.clients),
2115
 
                    signature="oa{sv}")
2116
 
            
2117
 
            @dbus.service.method(_interface, in_signature="o")
2118
 
            def RemoveClient(self, object_path):
2119
 
                "D-Bus method"
2120
 
                for c in tcp_server.clients:
2121
 
                    if c.dbus_object_path == object_path:
2122
 
                        tcp_server.clients.remove(c)
2123
 
                        c.remove_from_connection()
2124
 
                        # Don't signal anything except ClientRemoved
2125
 
                        c.disable(quiet=True)
2126
 
                        # Emit D-Bus signal
2127
 
                        self.ClientRemoved(object_path, c.name)
2128
 
                        return
2129
 
                raise KeyError(object_path)
2130
 
            
2131
 
            del _interface
2132
 
        
2133
 
        class MandosDBusServiceTransitional(MandosDBusService):
2134
 
            __metaclass__ = AlternateDBusNamesMetaclass
2135
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
701
        daemon(False, False)
2136
702
    
2137
703
    def cleanup():
2138
704
        "Cleanup function; run on exit"
2139
 
        service.cleanup()
2140
 
        
2141
 
        multiprocessing.active_children()
2142
 
        while tcp_server.clients:
2143
 
            client = tcp_server.clients.pop()
2144
 
            if use_dbus:
2145
 
                client.remove_from_connection()
2146
 
            client.disable_hook = None
2147
 
            # Don't signal anything except ClientRemoved
2148
 
            client.disable(quiet=True)
2149
 
            if use_dbus:
2150
 
                # Emit D-Bus signal
2151
 
                mandos_dbus_service.ClientRemoved(client
2152
 
                                                  .dbus_object_path,
2153
 
                                                  client.name)
2154
 
    
2155
 
    atexit.register(cleanup)
2156
 
    
2157
 
    for client in tcp_server.clients:
2158
 
        if use_dbus:
2159
 
            # Emit D-Bus signal
2160
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2161
 
        client.enable()
2162
 
    
2163
 
    tcp_server.enable()
2164
 
    tcp_server.server_activate()
2165
 
    
2166
 
    # Find out what port we got
2167
 
    service.port = tcp_server.socket.getsockname()[1]
2168
 
    if use_ipv6:
2169
 
        logger.info("Now listening on address %r, port %d,"
2170
 
                    " flowinfo %d, scope_id %d"
2171
 
                    % tcp_server.socket.getsockname())
2172
 
    else:                       # IPv4
2173
 
        logger.info("Now listening on address %r, port %d"
2174
 
                    % tcp_server.socket.getsockname())
2175
 
    
2176
 
    #service.interface = tcp_server.socket.getsockname()[3]
2177
 
    
2178
 
    try:
 
705
        global group
2179
706
        # From the Avahi example code
2180
 
        try:
2181
 
            service.activate()
2182
 
        except dbus.exceptions.DBusException as error:
2183
 
            logger.critical("DBusException: %s", error)
2184
 
            cleanup()
2185
 
            sys.exit(1)
 
707
        if not group is None:
 
708
            group.Free()
 
709
            group = None
2186
710
        # End of Avahi example code
2187
711
        
2188
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2189
 
                             lambda *args, **kwargs:
2190
 
                             (tcp_server.handle_request
2191
 
                              (*args[2:], **kwargs) or True))
2192
 
        
 
712
        while clients:
 
713
            client = clients.pop()
 
714
            client.stop_hook = None
 
715
            client.stop()
 
716
    
 
717
    atexit.register(cleanup)
 
718
    
 
719
    if not debug:
 
720
        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())
 
723
    
 
724
    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:
2193
754
        logger.debug("Starting main loop")
 
755
        main_loop_started = True
2194
756
        main_loop.run()
2195
 
    except AvahiError as error:
2196
 
        logger.critical("AvahiError: %s", error)
2197
 
        cleanup()
2198
 
        sys.exit(1)
2199
757
    except KeyboardInterrupt:
2200
758
        if debug:
2201
 
            print("", file=sys.stderr)
2202
 
        logger.debug("Server received KeyboardInterrupt")
2203
 
    logger.debug("Server exiting")
2204
 
    # Must run before the D-Bus bus name gets deregistered
2205
 
    cleanup()
2206
 
 
 
759
            print
 
760
    
 
761
    sys.exit(exitstatus)
2207
762
 
2208
763
if __name__ == '__main__':
2209
764
    main()