/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-05-25 07:54:07 UTC
  • mto: This revision was merged to the branch mainline in revision 756.
  • Revision ID: teddy@recompile.se-20150525075407-x7u0z4f1zej6bm87
mandos (subprocess_call_pipe): Rename to "call_pipe" and take "func".

Generalize "subprocess_call_pipe" to "call_pipe" which takes an
additional "func" argument which is the function to be run.

Show diffs side-by-side

added added

removed removed

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