/mandos/trunk

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

« back to all changes in this revision

Viewing changes to server.py

  • Committer: Björn Påhlsson
  • Date: 2008-07-20 03:51:41 UTC
  • Revision ID: belorn@braxen-20080720035141-ta0y0be7fotdm4ks
Fixed a overbufferflow bug, thanks to a forgotten \0

Show diffs side-by-side

added added

removed removed

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