/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2012-01-02 01:58:41 UTC
  • Revision ID: teddy@recompile.se-20120102015841-2krpl2epdhishtpg
* mandos: Consistent terminology; use the term "secret" for the
          client's stored data.
  (ClientDBus.__init__): Removed dead code.
  (Clienthandler.handle): Bug fix: send NewRequest signal with only IP
                          address, not str() of address tuple.

Show diffs side-by-side

added added

removed removed

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