/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2009-01-18 00:16:57 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090118001657-6mo3ae73ldy5tegf
* debian/mandos-client.postinst: Converted to Bourne shell.  Also
                                 minor message change.
* debian/mandos-client.postrm: Minor message change.
* debian/mandos.postinst: Converted to Bourne shell.  Also minor
                          message change.
* debian/mandos.prerm: Minor message change.

Show diffs side-by-side

added added

removed removed

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