/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2009-01-05 23:26:06 UTC
  • mfrom: (237.2.11 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20090105232606-2iohqjcsfj076z7i
Merge from trunk, but disable the unfinished D-Bus feature:

* Makefile (PROGS): Removed "mandos-list".
  (mandos-list): Removed.
* mandos (main): Hide "--no-dbus" option.  Hard-code "use_dbus" to
                 "False".
* mandos-list: Removed.
* mandos.xml (SYNOPSIS): Removed "--no-dbus" option.
  (OPTIONS): - '' -
  (D-BUS INTERFACE): Removed section.

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