/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: 2011-11-26 23:08:17 UTC
  • mto: (518.1.8 mandos-persistent)
  • mto: This revision was merged to the branch mainline in revision 524.
  • Revision ID: teddy@recompile.se-20111126230817-tv08v831s2yltbkd
Make "enabled" a client config option.

* DBUS-API: Fix wording on "Expires" option.
* clients.conf (enabled): New.
* mandos (Client): "last_enabled" can now be None.
  (Client.__init__): Get "enabled" from config.  Only set
                     "last_enabled" and "expires" if enabled.
  (ClientDBus.Created_dbus_property): Removed redundant dbus.String().
  (ClientDBus.Interval_dbus_property): If changed, only reschedule
                                       checker if enabled.
  (main/special_settings): Added "enabled".
* mandos-clients.conf (OPTIONS): Added "enabled".

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python3 -bI
2
 
# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
3
 
#
 
1
#!/usr/bin/python
 
2
# -*- mode: python; coding: utf-8 -*-
 
3
4
4
# Mandos server - give out binary blobs to connecting clients.
5
 
#
 
5
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
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
 
#
 
12
13
13
# Everything else is
14
 
# Copyright © 2008-2019 Teddy Hogeborn
15
 
# Copyright © 2008-2019 Björn Påhlsson
16
 
#
17
 
# This file is part of Mandos.
18
 
#
19
 
# Mandos is free software: you can redistribute it and/or modify it
20
 
# under the terms of the GNU General Public License as published by
 
14
# Copyright © 2008-2011 Teddy Hogeborn
 
15
# Copyright © 2008-2011 Björn Påhlsson
 
16
 
17
# This program is free software: you can redistribute it and/or modify
 
18
# it under the terms of the GNU General Public License as published by
21
19
# the Free Software Foundation, either version 3 of the License, or
22
20
# (at your option) any later version.
23
21
#
24
 
#     Mandos is distributed in the hope that it will be useful, but
25
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
22
#     This program is distributed in the hope that it will be useful,
 
23
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
26
24
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27
25
#     GNU General Public License for more details.
28
 
#
 
26
29
27
# You should have received a copy of the GNU General Public License
30
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
31
 
#
 
28
# along with this program.  If not, see
 
29
# <http://www.gnu.org/licenses/>.
 
30
32
31
# Contact the authors at <mandos@recompile.se>.
33
 
#
 
32
34
33
 
35
34
from __future__ import (division, absolute_import, print_function,
36
35
                        unicode_literals)
37
36
 
38
 
try:
39
 
    from future_builtins import *
40
 
except ImportError:
41
 
    pass
42
 
 
43
 
try:
44
 
    import SocketServer as socketserver
45
 
except ImportError:
46
 
    import socketserver
 
37
import SocketServer as socketserver
47
38
import socket
48
39
import argparse
49
40
import datetime
50
41
import errno
51
 
try:
52
 
    import ConfigParser as configparser
53
 
except ImportError:
54
 
    import configparser
 
42
import gnutls.crypto
 
43
import gnutls.connection
 
44
import gnutls.errors
 
45
import gnutls.library.functions
 
46
import gnutls.library.constants
 
47
import gnutls.library.types
 
48
import ConfigParser as configparser
55
49
import sys
56
50
import re
57
51
import os
66
60
import struct
67
61
import fcntl
68
62
import functools
69
 
try:
70
 
    import cPickle as pickle
71
 
except ImportError:
72
 
    import pickle
 
63
import cPickle as pickle
73
64
import multiprocessing
74
65
import types
75
66
import binascii
76
67
import tempfile
77
 
import itertools
78
 
import collections
79
 
import codecs
80
 
import unittest
81
68
 
82
69
import dbus
83
70
import dbus.service
84
 
import gi
85
 
from gi.repository import GLib
 
71
import gobject
 
72
import avahi
86
73
from dbus.mainloop.glib import DBusGMainLoop
87
74
import ctypes
88
75
import ctypes.util
89
76
import xml.dom.minidom
90
77
import inspect
91
 
 
92
 
if sys.version_info.major == 2:
93
 
    __metaclass__ = type
94
 
    str = unicode
95
 
 
96
 
# Show warnings by default
97
 
if not sys.warnoptions:
98
 
    import warnings
99
 
    warnings.simplefilter("default")
100
 
 
101
 
# Try to find the value of SO_BINDTODEVICE:
 
78
import GnuPGInterface
 
79
 
102
80
try:
103
 
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
104
 
    # newer, and it is also the most natural place for it:
105
81
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
106
82
except AttributeError:
107
83
    try:
108
 
        # This is where SO_BINDTODEVICE was up to and including Python
109
 
        # 2.6, and also 3.2:
110
84
        from IN import SO_BINDTODEVICE
111
85
    except ImportError:
112
 
        # In Python 2.7 it seems to have been removed entirely.
113
 
        # Try running the C preprocessor:
114
 
        try:
115
 
            cc = subprocess.Popen(["cc", "--language=c", "-E",
116
 
                                   "/dev/stdin"],
117
 
                                  stdin=subprocess.PIPE,
118
 
                                  stdout=subprocess.PIPE)
119
 
            stdout = cc.communicate(
120
 
                "#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
121
 
            SO_BINDTODEVICE = int(stdout.splitlines()[-1])
122
 
        except (OSError, ValueError, IndexError):
123
 
            # No value found
124
 
            SO_BINDTODEVICE = None
125
 
 
126
 
if sys.version_info < (3, 2):
127
 
    configparser.Configparser = configparser.SafeConfigParser
128
 
 
129
 
version = "1.8.9"
 
86
        SO_BINDTODEVICE = None
 
87
 
 
88
 
 
89
version = "1.4.1"
130
90
stored_state_file = "clients.pickle"
131
91
 
132
92
logger = logging.getLogger()
133
 
logging.captureWarnings(True)   # Show warnings via the logging system
134
 
syslogger = None
 
93
syslogger = (logging.handlers.SysLogHandler
 
94
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
95
              address = str("/dev/log")))
135
96
 
136
97
try:
137
 
    if_nametoindex = ctypes.cdll.LoadLibrary(
138
 
        ctypes.util.find_library("c")).if_nametoindex
 
98
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
99
                      (ctypes.util.find_library("c"))
 
100
                      .if_nametoindex)
139
101
except (OSError, AttributeError):
140
 
 
141
102
    def if_nametoindex(interface):
142
103
        "Get an interface index the hard way, i.e. using fcntl()"
143
104
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
144
105
        with contextlib.closing(socket.socket()) as s:
145
106
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
146
 
                                struct.pack(b"16s16x", interface))
147
 
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
107
                                struct.pack(str("16s16x"),
 
108
                                            interface))
 
109
        interface_index = struct.unpack(str("I"),
 
110
                                        ifreq[16:20])[0]
148
111
        return interface_index
149
112
 
150
113
 
151
 
def copy_function(func):
152
 
    """Make a copy of a function"""
153
 
    if sys.version_info.major == 2:
154
 
        return types.FunctionType(func.func_code,
155
 
                                  func.func_globals,
156
 
                                  func.func_name,
157
 
                                  func.func_defaults,
158
 
                                  func.func_closure)
159
 
    else:
160
 
        return types.FunctionType(func.__code__,
161
 
                                  func.__globals__,
162
 
                                  func.__name__,
163
 
                                  func.__defaults__,
164
 
                                  func.__closure__)
165
 
 
166
 
 
167
 
def initlogger(debug, level=logging.WARNING):
 
114
def initlogger(level=logging.WARNING):
168
115
    """init logger and add loglevel"""
169
 
 
170
 
    global syslogger
171
 
    syslogger = (logging.handlers.SysLogHandler(
172
 
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
173
 
        address="/dev/log"))
 
116
    
174
117
    syslogger.setFormatter(logging.Formatter
175
118
                           ('Mandos [%(process)d]: %(levelname)s:'
176
119
                            ' %(message)s'))
177
120
    logger.addHandler(syslogger)
178
 
 
179
 
    if debug:
180
 
        console = logging.StreamHandler()
181
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
182
 
                                               ' [%(process)d]:'
183
 
                                               ' %(levelname)s:'
184
 
                                               ' %(message)s'))
185
 
        logger.addHandler(console)
 
121
    
 
122
    console = logging.StreamHandler()
 
123
    console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
124
                                           ' [%(process)d]:'
 
125
                                           ' %(levelname)s:'
 
126
                                           ' %(message)s'))
 
127
    logger.addHandler(console)
186
128
    logger.setLevel(level)
187
129
 
188
130
 
189
 
class PGPError(Exception):
190
 
    """Exception if encryption/decryption fails"""
 
131
class CryptoError(Exception):
191
132
    pass
192
133
 
193
134
 
194
 
class PGPEngine:
 
135
class Crypto(object):
195
136
    """A simple class for OpenPGP symmetric encryption & decryption"""
196
 
 
197
137
    def __init__(self):
 
138
        self.gnupg = GnuPGInterface.GnuPG()
198
139
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
199
 
        self.gpg = "gpg"
200
 
        try:
201
 
            output = subprocess.check_output(["gpgconf"])
202
 
            for line in output.splitlines():
203
 
                name, text, path = line.split(b":")
204
 
                if name == b"gpg":
205
 
                    self.gpg = path
206
 
                    break
207
 
        except OSError as e:
208
 
            if e.errno != errno.ENOENT:
209
 
                raise
210
 
        self.gnupgargs = ['--batch',
211
 
                          '--homedir', self.tempdir,
212
 
                          '--force-mdc',
213
 
                          '--quiet']
214
 
        # Only GPG version 1 has the --no-use-agent option.
215
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
216
 
            self.gnupgargs.append("--no-use-agent")
217
 
 
 
140
        self.gnupg = GnuPGInterface.GnuPG()
 
141
        self.gnupg.options.meta_interactive = False
 
142
        self.gnupg.options.homedir = self.tempdir
 
143
        self.gnupg.options.extra_args.extend(['--force-mdc',
 
144
                                              '--quiet'])
 
145
    
218
146
    def __enter__(self):
219
147
        return self
220
 
 
221
 
    def __exit__(self, exc_type, exc_value, traceback):
 
148
    
 
149
    def __exit__ (self, exc_type, exc_value, traceback):
222
150
        self._cleanup()
223
151
        return False
224
 
 
 
152
    
225
153
    def __del__(self):
226
154
        self._cleanup()
227
 
 
 
155
    
228
156
    def _cleanup(self):
229
157
        if self.tempdir is not None:
230
158
            # Delete contents of tempdir
231
159
            for root, dirs, files in os.walk(self.tempdir,
232
 
                                             topdown=False):
 
160
                                             topdown = False):
233
161
                for filename in files:
234
162
                    os.remove(os.path.join(root, filename))
235
163
                for dirname in dirs:
237
165
            # Remove tempdir
238
166
            os.rmdir(self.tempdir)
239
167
            self.tempdir = None
240
 
 
 
168
    
241
169
    def password_encode(self, password):
242
170
        # Passphrase can not be empty and can not contain newlines or
243
171
        # NUL bytes.  So we prefix it and hex encode it.
244
 
        encoded = b"mandos" + binascii.hexlify(password)
245
 
        if len(encoded) > 2048:
246
 
            # GnuPG can't handle long passwords, so encode differently
247
 
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
248
 
                       .replace(b"\n", b"\\n")
249
 
                       .replace(b"\0", b"\\x00"))
250
 
        return encoded
251
 
 
 
172
        return b"mandos" + binascii.hexlify(password)
 
173
    
252
174
    def encrypt(self, data, password):
253
 
        passphrase = self.password_encode(password)
254
 
        with tempfile.NamedTemporaryFile(
255
 
                dir=self.tempdir) as passfile:
256
 
            passfile.write(passphrase)
257
 
            passfile.flush()
258
 
            proc = subprocess.Popen([self.gpg, '--symmetric',
259
 
                                     '--passphrase-file',
260
 
                                     passfile.name]
261
 
                                    + self.gnupgargs,
262
 
                                    stdin=subprocess.PIPE,
263
 
                                    stdout=subprocess.PIPE,
264
 
                                    stderr=subprocess.PIPE)
265
 
            ciphertext, err = proc.communicate(input=data)
266
 
        if proc.returncode != 0:
267
 
            raise PGPError(err)
 
175
        self.gnupg.passphrase = self.password_encode(password)
 
176
        with open(os.devnull) as devnull:
 
177
            try:
 
178
                proc = self.gnupg.run(['--symmetric'],
 
179
                                      create_fhs=['stdin', 'stdout'],
 
180
                                      attach_fhs={'stderr': devnull})
 
181
                with contextlib.closing(proc.handles['stdin']) as f:
 
182
                    f.write(data)
 
183
                with contextlib.closing(proc.handles['stdout']) as f:
 
184
                    ciphertext = f.read()
 
185
                proc.wait()
 
186
            except IOError as e:
 
187
                raise CryptoError(e)
 
188
        self.gnupg.passphrase = None
268
189
        return ciphertext
269
 
 
 
190
    
270
191
    def decrypt(self, data, password):
271
 
        passphrase = self.password_encode(password)
272
 
        with tempfile.NamedTemporaryFile(
273
 
                dir=self.tempdir) as passfile:
274
 
            passfile.write(passphrase)
275
 
            passfile.flush()
276
 
            proc = subprocess.Popen([self.gpg, '--decrypt',
277
 
                                     '--passphrase-file',
278
 
                                     passfile.name]
279
 
                                    + self.gnupgargs,
280
 
                                    stdin=subprocess.PIPE,
281
 
                                    stdout=subprocess.PIPE,
282
 
                                    stderr=subprocess.PIPE)
283
 
            decrypted_plaintext, err = proc.communicate(input=data)
284
 
        if proc.returncode != 0:
285
 
            raise PGPError(err)
 
192
        self.gnupg.passphrase = self.password_encode(password)
 
193
        with open(os.devnull) as devnull:
 
194
            try:
 
195
                proc = self.gnupg.run(['--decrypt'],
 
196
                                      create_fhs=['stdin', 'stdout'],
 
197
                                      attach_fhs={'stderr': devnull})
 
198
                with contextlib.closing(proc.handles['stdin'] ) as f:
 
199
                    f.write(data)
 
200
                with contextlib.closing(proc.handles['stdout']) as f:
 
201
                    decrypted_plaintext = f.read()
 
202
                proc.wait()
 
203
            except IOError as e:
 
204
                raise CryptoError(e)
 
205
        self.gnupg.passphrase = None
286
206
        return decrypted_plaintext
287
207
 
288
208
 
289
 
# Pretend that we have an Avahi module
290
 
class avahi:
291
 
    """This isn't so much a class as it is a module-like namespace."""
292
 
    IF_UNSPEC = -1               # avahi-common/address.h
293
 
    PROTO_UNSPEC = -1            # avahi-common/address.h
294
 
    PROTO_INET = 0               # avahi-common/address.h
295
 
    PROTO_INET6 = 1              # avahi-common/address.h
296
 
    DBUS_NAME = "org.freedesktop.Avahi"
297
 
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
298
 
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
299
 
    DBUS_PATH_SERVER = "/"
300
 
 
301
 
    @staticmethod
302
 
    def string_array_to_txt_array(t):
303
 
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
304
 
                           for s in t), signature="ay")
305
 
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
306
 
    ENTRY_GROUP_COLLISION = 3    # avahi-common/defs.h
307
 
    ENTRY_GROUP_FAILURE = 4      # avahi-common/defs.h
308
 
    SERVER_INVALID = 0           # avahi-common/defs.h
309
 
    SERVER_REGISTERING = 1       # avahi-common/defs.h
310
 
    SERVER_RUNNING = 2           # avahi-common/defs.h
311
 
    SERVER_COLLISION = 3         # avahi-common/defs.h
312
 
    SERVER_FAILURE = 4           # avahi-common/defs.h
313
 
 
314
209
 
315
210
class AvahiError(Exception):
316
211
    def __init__(self, value, *args, **kwargs):
317
212
        self.value = value
318
 
        return super(AvahiError, self).__init__(value, *args,
319
 
                                                **kwargs)
320
 
 
 
213
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
214
    def __unicode__(self):
 
215
        return unicode(repr(self.value))
321
216
 
322
217
class AvahiServiceError(AvahiError):
323
218
    pass
324
219
 
325
 
 
326
220
class AvahiGroupError(AvahiError):
327
221
    pass
328
222
 
329
223
 
330
 
class AvahiService:
 
224
class AvahiService(object):
331
225
    """An Avahi (Zeroconf) service.
332
 
 
 
226
    
333
227
    Attributes:
334
228
    interface: integer; avahi.IF_UNSPEC or an interface index.
335
229
               Used to optionally bind to the specified interface.
336
230
    name: string; Example: 'Mandos'
337
231
    type: string; Example: '_mandos._tcp'.
338
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
232
                  See <http://www.dns-sd.org/ServiceTypes.html>
339
233
    port: integer; what port to announce
340
234
    TXT: list of strings; TXT record for the service
341
235
    domain: string; Domain to publish on, default to .local if empty.
347
241
    server: D-Bus Server
348
242
    bus: dbus.SystemBus()
349
243
    """
350
 
 
351
 
    def __init__(self,
352
 
                 interface=avahi.IF_UNSPEC,
353
 
                 name=None,
354
 
                 servicetype=None,
355
 
                 port=None,
356
 
                 TXT=None,
357
 
                 domain="",
358
 
                 host="",
359
 
                 max_renames=32768,
360
 
                 protocol=avahi.PROTO_UNSPEC,
361
 
                 bus=None):
 
244
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
 
245
                 servicetype = None, port = None, TXT = None,
 
246
                 domain = "", host = "", max_renames = 32768,
 
247
                 protocol = avahi.PROTO_UNSPEC, bus = None):
362
248
        self.interface = interface
363
249
        self.name = name
364
250
        self.type = servicetype
373
259
        self.server = None
374
260
        self.bus = bus
375
261
        self.entry_group_state_changed_match = None
376
 
 
377
 
    def rename(self, remove=True):
 
262
    def rename(self):
378
263
        """Derived from the Avahi example code"""
379
264
        if self.rename_count >= self.max_renames:
380
265
            logger.critical("No suitable Zeroconf service name found"
381
266
                            " after %i retries, exiting.",
382
267
                            self.rename_count)
383
268
            raise AvahiServiceError("Too many renames")
384
 
        self.name = str(
385
 
            self.server.GetAlternativeServiceName(self.name))
386
 
        self.rename_count += 1
 
269
        self.name = unicode(self.server
 
270
                            .GetAlternativeServiceName(self.name))
387
271
        logger.info("Changing Zeroconf service name to %r ...",
388
272
                    self.name)
389
 
        if remove:
390
 
            self.remove()
 
273
        self.remove()
391
274
        try:
392
275
            self.add()
393
276
        except dbus.exceptions.DBusException as error:
394
 
            if (error.get_dbus_name()
395
 
                == "org.freedesktop.Avahi.CollisionError"):
396
 
                logger.info("Local Zeroconf service name collision.")
397
 
                return self.rename(remove=False)
398
 
            else:
399
 
                logger.critical("D-Bus Exception", exc_info=error)
400
 
                self.cleanup()
401
 
                os._exit(1)
402
 
 
 
277
            logger.critical("DBusException: %s", error)
 
278
            self.cleanup()
 
279
            os._exit(1)
 
280
        self.rename_count += 1
403
281
    def remove(self):
404
282
        """Derived from the Avahi example code"""
405
283
        if self.entry_group_state_changed_match is not None:
407
285
            self.entry_group_state_changed_match = None
408
286
        if self.group is not None:
409
287
            self.group.Reset()
410
 
 
411
288
    def add(self):
412
289
        """Derived from the Avahi example code"""
413
290
        self.remove()
430
307
            dbus.UInt16(self.port),
431
308
            avahi.string_array_to_txt_array(self.TXT))
432
309
        self.group.Commit()
433
 
 
434
310
    def entry_group_state_changed(self, state, error):
435
311
        """Derived from the Avahi example code"""
436
312
        logger.debug("Avahi entry group state change: %i", state)
437
 
 
 
313
        
438
314
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
439
315
            logger.debug("Zeroconf service established.")
440
316
        elif state == avahi.ENTRY_GROUP_COLLISION:
442
318
            self.rename()
443
319
        elif state == avahi.ENTRY_GROUP_FAILURE:
444
320
            logger.critical("Avahi: Error in group state changed %s",
445
 
                            str(error))
446
 
            raise AvahiGroupError("State changed: {!s}".format(error))
447
 
 
 
321
                            unicode(error))
 
322
            raise AvahiGroupError("State changed: %s"
 
323
                                  % unicode(error))
448
324
    def cleanup(self):
449
325
        """Derived from the Avahi example code"""
450
326
        if self.group is not None:
455
331
                pass
456
332
            self.group = None
457
333
        self.remove()
458
 
 
459
334
    def server_state_changed(self, state, error=None):
460
335
        """Derived from the Avahi example code"""
461
336
        logger.debug("Avahi server state change: %i", state)
462
 
        bad_states = {
463
 
            avahi.SERVER_INVALID: "Zeroconf server invalid",
464
 
            avahi.SERVER_REGISTERING: None,
465
 
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
466
 
            avahi.SERVER_FAILURE: "Zeroconf server failure",
467
 
        }
 
337
        bad_states = { avahi.SERVER_INVALID:
 
338
                           "Zeroconf server invalid",
 
339
                       avahi.SERVER_REGISTERING: None,
 
340
                       avahi.SERVER_COLLISION:
 
341
                           "Zeroconf server name collision",
 
342
                       avahi.SERVER_FAILURE:
 
343
                           "Zeroconf server failure" }
468
344
        if state in bad_states:
469
345
            if bad_states[state] is not None:
470
346
                if error is None:
473
349
                    logger.error(bad_states[state] + ": %r", error)
474
350
            self.cleanup()
475
351
        elif state == avahi.SERVER_RUNNING:
476
 
            try:
477
 
                self.add()
478
 
            except dbus.exceptions.DBusException as error:
479
 
                if (error.get_dbus_name()
480
 
                    == "org.freedesktop.Avahi.CollisionError"):
481
 
                    logger.info("Local Zeroconf service name"
482
 
                                " collision.")
483
 
                    return self.rename(remove=False)
484
 
                else:
485
 
                    logger.critical("D-Bus Exception", exc_info=error)
486
 
                    self.cleanup()
487
 
                    os._exit(1)
 
352
            self.add()
488
353
        else:
489
354
            if error is None:
490
355
                logger.debug("Unknown state: %r", state)
491
356
            else:
492
357
                logger.debug("Unknown state: %r: %r", state, error)
493
 
 
494
358
    def activate(self):
495
359
        """Derived from the Avahi example code"""
496
360
        if self.server is None:
500
364
                                    follow_name_owner_changes=True),
501
365
                avahi.DBUS_INTERFACE_SERVER)
502
366
        self.server.connect_to_signal("StateChanged",
503
 
                                      self.server_state_changed)
 
367
                                 self.server_state_changed)
504
368
        self.server_state_changed(self.server.GetState())
505
369
 
506
 
 
507
370
class AvahiServiceToSyslog(AvahiService):
508
 
    def rename(self, *args, **kwargs):
 
371
    def rename(self):
509
372
        """Add the new name to the syslog messages"""
510
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
511
 
        syslogger.setFormatter(logging.Formatter(
512
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
513
 
            .format(self.name)))
 
373
        ret = AvahiService.rename(self)
 
374
        syslogger.setFormatter(logging.Formatter
 
375
                               ('Mandos (%s) [%%(process)d]:'
 
376
                                ' %%(levelname)s: %%(message)s'
 
377
                                % self.name))
514
378
        return ret
515
379
 
516
 
 
517
 
# Pretend that we have a GnuTLS module
518
 
class gnutls:
519
 
    """This isn't so much a class as it is a module-like namespace."""
520
 
 
521
 
    library = ctypes.util.find_library("gnutls")
522
 
    if library is None:
523
 
        library = ctypes.util.find_library("gnutls-deb0")
524
 
    _library = ctypes.cdll.LoadLibrary(library)
525
 
    del library
526
 
 
527
 
    # Unless otherwise indicated, the constants and types below are
528
 
    # all from the gnutls/gnutls.h C header file.
529
 
 
530
 
    # Constants
531
 
    E_SUCCESS = 0
532
 
    E_INTERRUPTED = -52
533
 
    E_AGAIN = -28
534
 
    CRT_OPENPGP = 2
535
 
    CRT_RAWPK = 3
536
 
    CLIENT = 2
537
 
    SHUT_RDWR = 0
538
 
    CRD_CERTIFICATE = 1
539
 
    E_NO_CERTIFICATE_FOUND = -49
540
 
    X509_FMT_DER = 0
541
 
    NO_TICKETS = 1<<10
542
 
    ENABLE_RAWPK = 1<<18
543
 
    CTYPE_PEERS = 3
544
 
    KEYID_USE_SHA256 = 1        # gnutls/x509.h
545
 
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
546
 
 
547
 
    # Types
548
 
    class session_int(ctypes.Structure):
549
 
        _fields_ = []
550
 
    session_t = ctypes.POINTER(session_int)
551
 
 
552
 
    class certificate_credentials_st(ctypes.Structure):
553
 
        _fields_ = []
554
 
    certificate_credentials_t = ctypes.POINTER(
555
 
        certificate_credentials_st)
556
 
    certificate_type_t = ctypes.c_int
557
 
 
558
 
    class datum_t(ctypes.Structure):
559
 
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
560
 
                    ('size', ctypes.c_uint)]
561
 
 
562
 
    class openpgp_crt_int(ctypes.Structure):
563
 
        _fields_ = []
564
 
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
565
 
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
566
 
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
567
 
    credentials_type_t = ctypes.c_int
568
 
    transport_ptr_t = ctypes.c_void_p
569
 
    close_request_t = ctypes.c_int
570
 
 
571
 
    # Exceptions
572
 
    class Error(Exception):
573
 
        def __init__(self, message=None, code=None, args=()):
574
 
            # Default usage is by a message string, but if a return
575
 
            # code is passed, convert it to a string with
576
 
            # gnutls.strerror()
577
 
            self.code = code
578
 
            if message is None and code is not None:
579
 
                message = gnutls.strerror(code)
580
 
            return super(gnutls.Error, self).__init__(
581
 
                message, *args)
582
 
 
583
 
    class CertificateSecurityError(Error):
584
 
        pass
585
 
 
586
 
    # Classes
587
 
    class Credentials:
588
 
        def __init__(self):
589
 
            self._c_object = gnutls.certificate_credentials_t()
590
 
            gnutls.certificate_allocate_credentials(
591
 
                ctypes.byref(self._c_object))
592
 
            self.type = gnutls.CRD_CERTIFICATE
593
 
 
594
 
        def __del__(self):
595
 
            gnutls.certificate_free_credentials(self._c_object)
596
 
 
597
 
    class ClientSession:
598
 
        def __init__(self, socket, credentials=None):
599
 
            self._c_object = gnutls.session_t()
600
 
            gnutls_flags = gnutls.CLIENT
601
 
            if gnutls.check_version(b"3.5.6"):
602
 
                gnutls_flags |= gnutls.NO_TICKETS
603
 
            if gnutls.has_rawpk:
604
 
                gnutls_flags |= gnutls.ENABLE_RAWPK
605
 
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
606
 
            del gnutls_flags
607
 
            gnutls.set_default_priority(self._c_object)
608
 
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
609
 
            gnutls.handshake_set_private_extensions(self._c_object,
610
 
                                                    True)
611
 
            self.socket = socket
612
 
            if credentials is None:
613
 
                credentials = gnutls.Credentials()
614
 
            gnutls.credentials_set(self._c_object, credentials.type,
615
 
                                   ctypes.cast(credentials._c_object,
616
 
                                               ctypes.c_void_p))
617
 
            self.credentials = credentials
618
 
 
619
 
        def __del__(self):
620
 
            gnutls.deinit(self._c_object)
621
 
 
622
 
        def handshake(self):
623
 
            return gnutls.handshake(self._c_object)
624
 
 
625
 
        def send(self, data):
626
 
            data = bytes(data)
627
 
            data_len = len(data)
628
 
            while data_len > 0:
629
 
                data_len -= gnutls.record_send(self._c_object,
630
 
                                               data[-data_len:],
631
 
                                               data_len)
632
 
 
633
 
        def bye(self):
634
 
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
635
 
 
636
 
    # Error handling functions
637
 
    def _error_code(result):
638
 
        """A function to raise exceptions on errors, suitable
639
 
        for the 'restype' attribute on ctypes functions"""
640
 
        if result >= 0:
641
 
            return result
642
 
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
643
 
            raise gnutls.CertificateSecurityError(code=result)
644
 
        raise gnutls.Error(code=result)
645
 
 
646
 
    def _retry_on_error(result, func, arguments):
647
 
        """A function to retry on some errors, suitable
648
 
        for the 'errcheck' attribute on ctypes functions"""
649
 
        while result < 0:
650
 
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
651
 
                return _error_code(result)
652
 
            result = func(*arguments)
653
 
        return result
654
 
 
655
 
    # Unless otherwise indicated, the function declarations below are
656
 
    # all from the gnutls/gnutls.h C header file.
657
 
 
658
 
    # Functions
659
 
    priority_set_direct = _library.gnutls_priority_set_direct
660
 
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
661
 
                                    ctypes.POINTER(ctypes.c_char_p)]
662
 
    priority_set_direct.restype = _error_code
663
 
 
664
 
    init = _library.gnutls_init
665
 
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
666
 
    init.restype = _error_code
667
 
 
668
 
    set_default_priority = _library.gnutls_set_default_priority
669
 
    set_default_priority.argtypes = [session_t]
670
 
    set_default_priority.restype = _error_code
671
 
 
672
 
    record_send = _library.gnutls_record_send
673
 
    record_send.argtypes = [session_t, ctypes.c_void_p,
674
 
                            ctypes.c_size_t]
675
 
    record_send.restype = ctypes.c_ssize_t
676
 
    record_send.errcheck = _retry_on_error
677
 
 
678
 
    certificate_allocate_credentials = (
679
 
        _library.gnutls_certificate_allocate_credentials)
680
 
    certificate_allocate_credentials.argtypes = [
681
 
        ctypes.POINTER(certificate_credentials_t)]
682
 
    certificate_allocate_credentials.restype = _error_code
683
 
 
684
 
    certificate_free_credentials = (
685
 
        _library.gnutls_certificate_free_credentials)
686
 
    certificate_free_credentials.argtypes = [
687
 
        certificate_credentials_t]
688
 
    certificate_free_credentials.restype = None
689
 
 
690
 
    handshake_set_private_extensions = (
691
 
        _library.gnutls_handshake_set_private_extensions)
692
 
    handshake_set_private_extensions.argtypes = [session_t,
693
 
                                                 ctypes.c_int]
694
 
    handshake_set_private_extensions.restype = None
695
 
 
696
 
    credentials_set = _library.gnutls_credentials_set
697
 
    credentials_set.argtypes = [session_t, credentials_type_t,
698
 
                                ctypes.c_void_p]
699
 
    credentials_set.restype = _error_code
700
 
 
701
 
    strerror = _library.gnutls_strerror
702
 
    strerror.argtypes = [ctypes.c_int]
703
 
    strerror.restype = ctypes.c_char_p
704
 
 
705
 
    certificate_type_get = _library.gnutls_certificate_type_get
706
 
    certificate_type_get.argtypes = [session_t]
707
 
    certificate_type_get.restype = _error_code
708
 
 
709
 
    certificate_get_peers = _library.gnutls_certificate_get_peers
710
 
    certificate_get_peers.argtypes = [session_t,
711
 
                                      ctypes.POINTER(ctypes.c_uint)]
712
 
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
713
 
 
714
 
    global_set_log_level = _library.gnutls_global_set_log_level
715
 
    global_set_log_level.argtypes = [ctypes.c_int]
716
 
    global_set_log_level.restype = None
717
 
 
718
 
    global_set_log_function = _library.gnutls_global_set_log_function
719
 
    global_set_log_function.argtypes = [log_func]
720
 
    global_set_log_function.restype = None
721
 
 
722
 
    deinit = _library.gnutls_deinit
723
 
    deinit.argtypes = [session_t]
724
 
    deinit.restype = None
725
 
 
726
 
    handshake = _library.gnutls_handshake
727
 
    handshake.argtypes = [session_t]
728
 
    handshake.restype = _error_code
729
 
    handshake.errcheck = _retry_on_error
730
 
 
731
 
    transport_set_ptr = _library.gnutls_transport_set_ptr
732
 
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
733
 
    transport_set_ptr.restype = None
734
 
 
735
 
    bye = _library.gnutls_bye
736
 
    bye.argtypes = [session_t, close_request_t]
737
 
    bye.restype = _error_code
738
 
    bye.errcheck = _retry_on_error
739
 
 
740
 
    check_version = _library.gnutls_check_version
741
 
    check_version.argtypes = [ctypes.c_char_p]
742
 
    check_version.restype = ctypes.c_char_p
743
 
 
744
 
    _need_version = b"3.3.0"
745
 
    if check_version(_need_version) is None:
746
 
        raise self.Error("Needs GnuTLS {} or later"
747
 
                         .format(_need_version))
748
 
 
749
 
    _tls_rawpk_version = b"3.6.6"
750
 
    has_rawpk = bool(check_version(_tls_rawpk_version))
751
 
 
752
 
    if has_rawpk:
753
 
        # Types
754
 
        class pubkey_st(ctypes.Structure):
755
 
            _fields = []
756
 
        pubkey_t = ctypes.POINTER(pubkey_st)
757
 
 
758
 
        x509_crt_fmt_t = ctypes.c_int
759
 
 
760
 
        # All the function declarations below are from gnutls/abstract.h
761
 
        pubkey_init = _library.gnutls_pubkey_init
762
 
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
763
 
        pubkey_init.restype = _error_code
764
 
 
765
 
        pubkey_import = _library.gnutls_pubkey_import
766
 
        pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
767
 
                                  x509_crt_fmt_t]
768
 
        pubkey_import.restype = _error_code
769
 
 
770
 
        pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
771
 
        pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
772
 
                                      ctypes.POINTER(ctypes.c_ubyte),
773
 
                                      ctypes.POINTER(ctypes.c_size_t)]
774
 
        pubkey_get_key_id.restype = _error_code
775
 
 
776
 
        pubkey_deinit = _library.gnutls_pubkey_deinit
777
 
        pubkey_deinit.argtypes = [pubkey_t]
778
 
        pubkey_deinit.restype = None
779
 
    else:
780
 
        # All the function declarations below are from gnutls/openpgp.h
781
 
 
782
 
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
783
 
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
784
 
        openpgp_crt_init.restype = _error_code
785
 
 
786
 
        openpgp_crt_import = _library.gnutls_openpgp_crt_import
787
 
        openpgp_crt_import.argtypes = [openpgp_crt_t,
788
 
                                       ctypes.POINTER(datum_t),
789
 
                                       openpgp_crt_fmt_t]
790
 
        openpgp_crt_import.restype = _error_code
791
 
 
792
 
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
793
 
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
794
 
                                            ctypes.POINTER(ctypes.c_uint)]
795
 
        openpgp_crt_verify_self.restype = _error_code
796
 
 
797
 
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
798
 
        openpgp_crt_deinit.argtypes = [openpgp_crt_t]
799
 
        openpgp_crt_deinit.restype = None
800
 
 
801
 
        openpgp_crt_get_fingerprint = (
802
 
            _library.gnutls_openpgp_crt_get_fingerprint)
803
 
        openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
804
 
                                                ctypes.c_void_p,
805
 
                                                ctypes.POINTER(
806
 
                                                    ctypes.c_size_t)]
807
 
        openpgp_crt_get_fingerprint.restype = _error_code
808
 
 
809
 
    if check_version(b"3.6.4"):
810
 
        certificate_type_get2 = _library.gnutls_certificate_type_get2
811
 
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
812
 
        certificate_type_get2.restype = _error_code
813
 
 
814
 
    # Remove non-public functions
815
 
    del _error_code, _retry_on_error
816
 
 
817
 
 
818
 
def call_pipe(connection,       # : multiprocessing.Connection
819
 
              func, *args, **kwargs):
820
 
    """This function is meant to be called by multiprocessing.Process
821
 
 
822
 
    This function runs func(*args, **kwargs), and writes the resulting
823
 
    return value on the provided multiprocessing.Connection.
824
 
    """
825
 
    connection.send(func(*args, **kwargs))
826
 
    connection.close()
827
 
 
828
 
 
829
 
class Client:
 
380
def _timedelta_to_milliseconds(td):
 
381
    "Convert a datetime.timedelta() to milliseconds"
 
382
    return ((td.days * 24 * 60 * 60 * 1000)
 
383
            + (td.seconds * 1000)
 
384
            + (td.microseconds // 1000))
 
385
        
 
386
class Client(object):
830
387
    """A representation of a client host served by this server.
831
 
 
 
388
    
832
389
    Attributes:
833
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
390
    _approved:   bool(); 'None' if not yet approved/disapproved
834
391
    approval_delay: datetime.timedelta(); Time to wait for approval
835
392
    approval_duration: datetime.timedelta(); Duration of one approval
836
 
    checker: multiprocessing.Process(); a running checker process used
837
 
             to see if the client lives. 'None' if no process is
838
 
             running.
839
 
    checker_callback_tag: a GLib event source tag, or None
 
393
    checker:    subprocess.Popen(); a running checker process used
 
394
                                    to see if the client lives.
 
395
                                    'None' if no process is running.
 
396
    checker_callback_tag: a gobject event source tag, or None
840
397
    checker_command: string; External command which is run to check
841
398
                     if client lives.  %() expansions are done at
842
399
                     runtime with vars(self) as dict, so that for
843
400
                     instance %(name)s can be used in the command.
844
 
    checker_initiator_tag: a GLib event source tag, or None
 
401
    checker_initiator_tag: a gobject event source tag, or None
845
402
    created:    datetime.datetime(); (UTC) object creation
846
403
    client_structure: Object describing what attributes a client has
847
404
                      and is used for storing the client at exit
848
405
    current_checker_command: string; current running checker_command
849
 
    disable_initiator_tag: a GLib event source tag, or None
 
406
    disable_initiator_tag: a gobject event source tag, or None
850
407
    enabled:    bool()
851
408
    fingerprint: string (40 or 32 hexadecimal digits); used to
852
 
                 uniquely identify an OpenPGP client
853
 
    key_id: string (64 hexadecimal digits); used to uniquely identify
854
 
            a client using raw public keys
 
409
                 uniquely identify the client
855
410
    host:       string; available for use by the checker command
856
411
    interval:   datetime.timedelta(); How often to start a new checker
857
412
    last_approval_request: datetime.datetime(); (UTC) or None
858
413
    last_checked_ok: datetime.datetime(); (UTC) or None
 
414
 
859
415
    last_checker_status: integer between 0 and 255 reflecting exit
860
416
                         status of last checker. -1 reflects crashed
861
 
                         checker, -2 means no checker completed yet.
862
 
    last_checker_signal: The signal which killed the last checker, if
863
 
                         last_checker_status is -1
 
417
                         checker, or None.
864
418
    last_enabled: datetime.datetime(); (UTC) or None
865
419
    name:       string; from the config file, used in log messages and
866
420
                        D-Bus identifiers
867
421
    secret:     bytestring; sent verbatim (over TLS) to client
868
422
    timeout:    datetime.timedelta(); How long from last_checked_ok
869
423
                                      until this client is disabled
870
 
    extended_timeout:   extra long timeout when secret has been sent
 
424
    extended_timeout:   extra long timeout when password has been sent
871
425
    runtime_expansions: Allowed attributes for runtime expansion.
872
426
    expires:    datetime.datetime(); time (UTC) when a client will be
873
427
                disabled, or None
874
 
    server_settings: The server_settings dict from main()
875
428
    """
876
 
 
 
429
    
877
430
    runtime_expansions = ("approval_delay", "approval_duration",
878
 
                          "created", "enabled", "expires", "key_id",
879
 
                          "fingerprint", "host", "interval",
880
 
                          "last_approval_request", "last_checked_ok",
 
431
                          "created", "enabled", "fingerprint",
 
432
                          "host", "interval", "last_checked_ok",
881
433
                          "last_enabled", "name", "timeout")
882
 
    client_defaults = {
883
 
        "timeout": "PT5M",
884
 
        "extended_timeout": "PT15M",
885
 
        "interval": "PT2M",
886
 
        "checker": "fping -q -- %%(host)s",
887
 
        "host": "",
888
 
        "approval_delay": "PT0S",
889
 
        "approval_duration": "PT1S",
890
 
        "approved_by_default": "True",
891
 
        "enabled": "True",
892
 
    }
893
 
 
894
 
    @staticmethod
895
 
    def config_parser(config):
896
 
        """Construct a new dict of client settings of this form:
897
 
        { client_name: {setting_name: value, ...}, ...}
898
 
        with exceptions for any special settings as defined above.
899
 
        NOTE: Must be a pure function. Must return the same result
900
 
        value given the same arguments.
901
 
        """
902
 
        settings = {}
903
 
        for client_name in config.sections():
904
 
            section = dict(config.items(client_name))
905
 
            client = settings[client_name] = {}
906
 
 
907
 
            client["host"] = section["host"]
908
 
            # Reformat values from string types to Python types
909
 
            client["approved_by_default"] = config.getboolean(
910
 
                client_name, "approved_by_default")
911
 
            client["enabled"] = config.getboolean(client_name,
912
 
                                                  "enabled")
913
 
 
914
 
            # Uppercase and remove spaces from key_id and fingerprint
915
 
            # for later comparison purposes with return value from the
916
 
            # key_id() and fingerprint() functions
917
 
            client["key_id"] = (section.get("key_id", "").upper()
918
 
                                .replace(" ", ""))
919
 
            client["fingerprint"] = (section["fingerprint"].upper()
920
 
                                     .replace(" ", ""))
921
 
            if "secret" in section:
922
 
                client["secret"] = codecs.decode(section["secret"]
923
 
                                                 .encode("utf-8"),
924
 
                                                 "base64")
925
 
            elif "secfile" in section:
926
 
                with open(os.path.expanduser(os.path.expandvars
927
 
                                             (section["secfile"])),
928
 
                          "rb") as secfile:
929
 
                    client["secret"] = secfile.read()
930
 
            else:
931
 
                raise TypeError("No secret or secfile for section {}"
932
 
                                .format(section))
933
 
            client["timeout"] = string_to_delta(section["timeout"])
934
 
            client["extended_timeout"] = string_to_delta(
935
 
                section["extended_timeout"])
936
 
            client["interval"] = string_to_delta(section["interval"])
937
 
            client["approval_delay"] = string_to_delta(
938
 
                section["approval_delay"])
939
 
            client["approval_duration"] = string_to_delta(
940
 
                section["approval_duration"])
941
 
            client["checker_command"] = section["checker"]
942
 
            client["last_approval_request"] = None
943
 
            client["last_checked_ok"] = None
944
 
            client["last_checker_status"] = -2
945
 
 
946
 
        return settings
947
 
 
948
 
    def __init__(self, settings, name=None, server_settings=None):
 
434
    
 
435
    def timeout_milliseconds(self):
 
436
        "Return the 'timeout' attribute in milliseconds"
 
437
        return _timedelta_to_milliseconds(self.timeout)
 
438
    
 
439
    def extended_timeout_milliseconds(self):
 
440
        "Return the 'extended_timeout' attribute in milliseconds"
 
441
        return _timedelta_to_milliseconds(self.extended_timeout)
 
442
    
 
443
    def interval_milliseconds(self):
 
444
        "Return the 'interval' attribute in milliseconds"
 
445
        return _timedelta_to_milliseconds(self.interval)
 
446
    
 
447
    def approval_delay_milliseconds(self):
 
448
        return _timedelta_to_milliseconds(self.approval_delay)
 
449
    
 
450
    def __init__(self, name = None, config=None):
 
451
        """Note: the 'checker' key in 'config' sets the
 
452
        'checker_command' attribute and *not* the 'checker'
 
453
        attribute."""
949
454
        self.name = name
950
 
        if server_settings is None:
951
 
            server_settings = {}
952
 
        self.server_settings = server_settings
953
 
        # adding all client settings
954
 
        for setting, value in settings.items():
955
 
            setattr(self, setting, value)
956
 
 
957
 
        if self.enabled:
958
 
            if not hasattr(self, "last_enabled"):
959
 
                self.last_enabled = datetime.datetime.utcnow()
960
 
            if not hasattr(self, "expires"):
961
 
                self.expires = (datetime.datetime.utcnow()
962
 
                                + self.timeout)
963
 
        else:
964
 
            self.last_enabled = None
965
 
            self.expires = None
966
 
 
 
455
        if config is None:
 
456
            config = {}
967
457
        logger.debug("Creating client %r", self.name)
968
 
        logger.debug("  Key ID: %s", self.key_id)
 
458
        # Uppercase and remove spaces from fingerprint for later
 
459
        # comparison purposes with return value from the fingerprint()
 
460
        # function
 
461
        self.fingerprint = (config["fingerprint"].upper()
 
462
                            .replace(" ", ""))
969
463
        logger.debug("  Fingerprint: %s", self.fingerprint)
970
 
        self.created = settings.get("created",
971
 
                                    datetime.datetime.utcnow())
972
 
 
973
 
        # attributes specific for this server instance
 
464
        if "secret" in config:
 
465
            self.secret = config["secret"].decode("base64")
 
466
        elif "secfile" in config:
 
467
            with open(os.path.expanduser(os.path.expandvars
 
468
                                         (config["secfile"])),
 
469
                      "rb") as secfile:
 
470
                self.secret = secfile.read()
 
471
        else:
 
472
            raise TypeError("No secret or secfile for client %s"
 
473
                            % self.name)
 
474
        self.host = config.get("host", "")
 
475
        self.created = datetime.datetime.utcnow()
 
476
        self.enabled = config.get("enabled", True)
 
477
        self.last_approval_request = None
 
478
        if self.enabled:
 
479
            self.last_enabled = datetime.datetime.utcnow()
 
480
        else:
 
481
            self.last_enabled = None
 
482
        self.last_checked_ok = None
 
483
        self.last_checker_status = None
 
484
        self.timeout = string_to_delta(config["timeout"])
 
485
        self.extended_timeout = string_to_delta(config
 
486
                                                ["extended_timeout"])
 
487
        self.interval = string_to_delta(config["interval"])
974
488
        self.checker = None
975
489
        self.checker_initiator_tag = None
976
490
        self.disable_initiator_tag = None
 
491
        if self.enabled:
 
492
            self.expires = datetime.datetime.utcnow() + self.timeout
 
493
        else:
 
494
            self.expires = None
977
495
        self.checker_callback_tag = None
 
496
        self.checker_command = config["checker"]
978
497
        self.current_checker_command = None
979
 
        self.approved = None
 
498
        self._approved = None
 
499
        self.approved_by_default = config.get("approved_by_default",
 
500
                                              True)
980
501
        self.approvals_pending = 0
981
 
        self.changedstate = multiprocessing_manager.Condition(
982
 
            multiprocessing_manager.Lock())
983
 
        self.client_structure = [attr
984
 
                                 for attr in self.__dict__.keys()
 
502
        self.approval_delay = string_to_delta(
 
503
            config["approval_delay"])
 
504
        self.approval_duration = string_to_delta(
 
505
            config["approval_duration"])
 
506
        self.changedstate = (multiprocessing_manager
 
507
                             .Condition(multiprocessing_manager
 
508
                                        .Lock()))
 
509
        self.client_structure = [attr for attr in
 
510
                                 self.__dict__.iterkeys()
985
511
                                 if not attr.startswith("_")]
986
512
        self.client_structure.append("client_structure")
987
 
 
988
 
        for name, t in inspect.getmembers(
989
 
                type(self), lambda obj: isinstance(obj, property)):
 
513
        
 
514
        for name, t in inspect.getmembers(type(self),
 
515
                                          lambda obj:
 
516
                                              isinstance(obj,
 
517
                                                         property)):
990
518
            if not name.startswith("_"):
991
519
                self.client_structure.append(name)
992
 
 
 
520
    
993
521
    # Send notice to process children that client state has changed
994
522
    def send_changedstate(self):
995
523
        with self.changedstate:
996
524
            self.changedstate.notify_all()
997
 
 
 
525
    
998
526
    def enable(self):
999
527
        """Start this client's checker and timeout hooks"""
1000
528
        if getattr(self, "enabled", False):
1001
529
            # Already enabled
1002
530
            return
 
531
        self.send_changedstate()
1003
532
        self.expires = datetime.datetime.utcnow() + self.timeout
1004
533
        self.enabled = True
1005
534
        self.last_enabled = datetime.datetime.utcnow()
1006
535
        self.init_checker()
1007
 
        self.send_changedstate()
1008
 
 
 
536
    
1009
537
    def disable(self, quiet=True):
1010
538
        """Disable this client."""
1011
539
        if not getattr(self, "enabled", False):
1012
540
            return False
1013
541
        if not quiet:
 
542
            self.send_changedstate()
 
543
        if not quiet:
1014
544
            logger.info("Disabling client %s", self.name)
1015
 
        if getattr(self, "disable_initiator_tag", None) is not None:
1016
 
            GLib.source_remove(self.disable_initiator_tag)
 
545
        if getattr(self, "disable_initiator_tag", False):
 
546
            gobject.source_remove(self.disable_initiator_tag)
1017
547
            self.disable_initiator_tag = None
1018
548
        self.expires = None
1019
 
        if getattr(self, "checker_initiator_tag", None) is not None:
1020
 
            GLib.source_remove(self.checker_initiator_tag)
 
549
        if getattr(self, "checker_initiator_tag", False):
 
550
            gobject.source_remove(self.checker_initiator_tag)
1021
551
            self.checker_initiator_tag = None
1022
552
        self.stop_checker()
1023
553
        self.enabled = False
1024
 
        if not quiet:
1025
 
            self.send_changedstate()
1026
 
        # Do not run this again if called by a GLib.timeout_add
 
554
        # Do not run this again if called by a gobject.timeout_add
1027
555
        return False
1028
 
 
 
556
    
1029
557
    def __del__(self):
1030
558
        self.disable()
1031
 
 
 
559
    
1032
560
    def init_checker(self):
1033
561
        # Schedule a new checker to be started an 'interval' from now,
1034
562
        # and every interval from then on.
1035
 
        if self.checker_initiator_tag is not None:
1036
 
            GLib.source_remove(self.checker_initiator_tag)
1037
 
        self.checker_initiator_tag = GLib.timeout_add(
1038
 
            int(self.interval.total_seconds() * 1000),
1039
 
            self.start_checker)
 
563
        self.checker_initiator_tag = (gobject.timeout_add
 
564
                                      (self.interval_milliseconds(),
 
565
                                       self.start_checker))
1040
566
        # Schedule a disable() when 'timeout' has passed
1041
 
        if self.disable_initiator_tag is not None:
1042
 
            GLib.source_remove(self.disable_initiator_tag)
1043
 
        self.disable_initiator_tag = GLib.timeout_add(
1044
 
            int(self.timeout.total_seconds() * 1000), self.disable)
 
567
        self.disable_initiator_tag = (gobject.timeout_add
 
568
                                   (self.timeout_milliseconds(),
 
569
                                    self.disable))
1045
570
        # Also start a new checker *right now*.
1046
571
        self.start_checker()
1047
 
 
1048
 
    def checker_callback(self, source, condition, connection,
1049
 
                         command):
 
572
    
 
573
    def checker_callback(self, pid, condition, command):
1050
574
        """The checker has completed, so take appropriate actions."""
1051
 
        # Read return code from connection (see call_pipe)
1052
 
        returncode = connection.recv()
1053
 
        connection.close()
1054
 
        if self.checker is not None:
1055
 
            self.checker.join()
1056
575
        self.checker_callback_tag = None
1057
576
        self.checker = None
1058
 
 
1059
 
        if returncode >= 0:
1060
 
            self.last_checker_status = returncode
1061
 
            self.last_checker_signal = None
 
577
        if os.WIFEXITED(condition):
 
578
            self.last_checker_status =  os.WEXITSTATUS(condition)
1062
579
            if self.last_checker_status == 0:
1063
580
                logger.info("Checker for %(name)s succeeded",
1064
581
                            vars(self))
1065
582
                self.checked_ok()
1066
583
            else:
1067
 
                logger.info("Checker for %(name)s failed", vars(self))
 
584
                logger.info("Checker for %(name)s failed",
 
585
                            vars(self))
1068
586
        else:
1069
587
            self.last_checker_status = -1
1070
 
            self.last_checker_signal = -returncode
1071
588
            logger.warning("Checker for %(name)s crashed?",
1072
589
                           vars(self))
1073
 
        return False
1074
 
 
1075
 
    def checked_ok(self):
1076
 
        """Assert that the client has been seen, alive and well."""
1077
 
        self.last_checked_ok = datetime.datetime.utcnow()
1078
 
        self.last_checker_status = 0
1079
 
        self.last_checker_signal = None
1080
 
        self.bump_timeout()
1081
 
 
1082
 
    def bump_timeout(self, timeout=None):
1083
 
        """Bump up the timeout for this client."""
 
590
    
 
591
    def checked_ok(self, timeout=None):
 
592
        """Bump up the timeout for this client.
 
593
        
 
594
        This should only be called when the client has been seen,
 
595
        alive and well.
 
596
        """
1084
597
        if timeout is None:
1085
598
            timeout = self.timeout
 
599
        self.last_checked_ok = datetime.datetime.utcnow()
1086
600
        if self.disable_initiator_tag is not None:
1087
 
            GLib.source_remove(self.disable_initiator_tag)
1088
 
            self.disable_initiator_tag = None
 
601
            gobject.source_remove(self.disable_initiator_tag)
1089
602
        if getattr(self, "enabled", False):
1090
 
            self.disable_initiator_tag = GLib.timeout_add(
1091
 
                int(timeout.total_seconds() * 1000), self.disable)
 
603
            self.disable_initiator_tag = (gobject.timeout_add
 
604
                                          (_timedelta_to_milliseconds
 
605
                                           (timeout), self.disable))
1092
606
            self.expires = datetime.datetime.utcnow() + timeout
1093
 
 
 
607
    
1094
608
    def need_approval(self):
1095
609
        self.last_approval_request = datetime.datetime.utcnow()
1096
 
 
 
610
    
1097
611
    def start_checker(self):
1098
612
        """Start a new checker subprocess if one is not running.
1099
 
 
 
613
        
1100
614
        If a checker already exists, leave it running and do
1101
615
        nothing."""
1102
616
        # The reason for not killing a running checker is that if we
1103
 
        # did that, and if a checker (for some reason) started running
1104
 
        # slowly and taking more than 'interval' time, then the client
1105
 
        # would inevitably timeout, since no checker would get a
1106
 
        # chance to run to completion.  If we instead leave running
 
617
        # did that, then if a checker (for some reason) started
 
618
        # running slowly and taking more than 'interval' time, the
 
619
        # client would inevitably timeout, since no checker would get
 
620
        # a chance to run to completion.  If we instead leave running
1107
621
        # checkers alone, the checker would have to take more time
1108
622
        # than 'timeout' for the client to be disabled, which is as it
1109
623
        # should be.
1110
 
 
1111
 
        if self.checker is not None and not self.checker.is_alive():
1112
 
            logger.warning("Checker was not alive; joining")
1113
 
            self.checker.join()
1114
 
            self.checker = None
 
624
        
 
625
        # If a checker exists, make sure it is not a zombie
 
626
        try:
 
627
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
628
        except (AttributeError, OSError) as error:
 
629
            if (isinstance(error, OSError)
 
630
                and error.errno != errno.ECHILD):
 
631
                raise error
 
632
        else:
 
633
            if pid:
 
634
                logger.warning("Checker was a zombie")
 
635
                gobject.source_remove(self.checker_callback_tag)
 
636
                self.checker_callback(pid, status,
 
637
                                      self.current_checker_command)
1115
638
        # Start a new checker if needed
1116
639
        if self.checker is None:
1117
 
            # Escape attributes for the shell
1118
 
            escaped_attrs = {
1119
 
                attr: re.escape(str(getattr(self, attr)))
1120
 
                for attr in self.runtime_expansions}
1121
640
            try:
1122
 
                command = self.checker_command % escaped_attrs
1123
 
            except TypeError as error:
1124
 
                logger.error('Could not format string "%s"',
1125
 
                             self.checker_command,
1126
 
                             exc_info=error)
1127
 
                return True     # Try again later
 
641
                # In case checker_command has exactly one % operator
 
642
                command = self.checker_command % self.host
 
643
            except TypeError:
 
644
                # Escape attributes for the shell
 
645
                escaped_attrs = dict(
 
646
                    (attr,
 
647
                     re.escape(unicode(str(getattr(self, attr, "")),
 
648
                                       errors=
 
649
                                       'replace')))
 
650
                    for attr in
 
651
                    self.runtime_expansions)
 
652
                
 
653
                try:
 
654
                    command = self.checker_command % escaped_attrs
 
655
                except TypeError as error:
 
656
                    logger.error('Could not format string "%s":'
 
657
                                 ' %s', self.checker_command, error)
 
658
                    return True # Try again later
1128
659
            self.current_checker_command = command
1129
 
            logger.info("Starting checker %r for %s", command,
1130
 
                        self.name)
1131
 
            # We don't need to redirect stdout and stderr, since
1132
 
            # in normal mode, that is already done by daemon(),
1133
 
            # and in debug mode we don't want to.  (Stdin is
1134
 
            # always replaced by /dev/null.)
1135
 
            # The exception is when not debugging but nevertheless
1136
 
            # running in the foreground; use the previously
1137
 
            # created wnull.
1138
 
            popen_args = {"close_fds": True,
1139
 
                          "shell": True,
1140
 
                          "cwd": "/"}
1141
 
            if (not self.server_settings["debug"]
1142
 
                and self.server_settings["foreground"]):
1143
 
                popen_args.update({"stdout": wnull,
1144
 
                                   "stderr": wnull})
1145
 
            pipe = multiprocessing.Pipe(duplex=False)
1146
 
            self.checker = multiprocessing.Process(
1147
 
                target=call_pipe,
1148
 
                args=(pipe[1], subprocess.call, command),
1149
 
                kwargs=popen_args)
1150
 
            self.checker.start()
1151
 
            self.checker_callback_tag = GLib.io_add_watch(
1152
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1153
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1154
 
                self.checker_callback, pipe[0], command)
1155
 
        # Re-run this periodically if run by GLib.timeout_add
 
660
            try:
 
661
                logger.info("Starting checker %r for %s",
 
662
                            command, self.name)
 
663
                # We don't need to redirect stdout and stderr, since
 
664
                # in normal mode, that is already done by daemon(),
 
665
                # and in debug mode we don't want to.  (Stdin is
 
666
                # always replaced by /dev/null.)
 
667
                self.checker = subprocess.Popen(command,
 
668
                                                close_fds=True,
 
669
                                                shell=True, cwd="/")
 
670
                self.checker_callback_tag = (gobject.child_watch_add
 
671
                                             (self.checker.pid,
 
672
                                              self.checker_callback,
 
673
                                              data=command))
 
674
                # The checker may have completed before the gobject
 
675
                # watch was added.  Check for this.
 
676
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
677
                if pid:
 
678
                    gobject.source_remove(self.checker_callback_tag)
 
679
                    self.checker_callback(pid, status, command)
 
680
            except OSError as error:
 
681
                logger.error("Failed to start subprocess: %s",
 
682
                             error)
 
683
        # Re-run this periodically if run by gobject.timeout_add
1156
684
        return True
1157
 
 
 
685
    
1158
686
    def stop_checker(self):
1159
687
        """Force the checker process, if any, to stop."""
1160
688
        if self.checker_callback_tag:
1161
 
            GLib.source_remove(self.checker_callback_tag)
 
689
            gobject.source_remove(self.checker_callback_tag)
1162
690
            self.checker_callback_tag = None
1163
691
        if getattr(self, "checker", None) is None:
1164
692
            return
1165
693
        logger.debug("Stopping checker for %(name)s", vars(self))
1166
 
        self.checker.terminate()
 
694
        try:
 
695
            os.kill(self.checker.pid, signal.SIGTERM)
 
696
            #time.sleep(0.5)
 
697
            #if self.checker.poll() is None:
 
698
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
699
        except OSError as error:
 
700
            if error.errno != errno.ESRCH: # No such process
 
701
                raise
1167
702
        self.checker = None
1168
703
 
1169
704
 
1170
 
def dbus_service_property(dbus_interface,
1171
 
                          signature="v",
1172
 
                          access="readwrite",
1173
 
                          byte_arrays=False):
 
705
def dbus_service_property(dbus_interface, signature="v",
 
706
                          access="readwrite", byte_arrays=False):
1174
707
    """Decorators for marking methods of a DBusObjectWithProperties to
1175
708
    become properties on the D-Bus.
1176
 
 
 
709
    
1177
710
    The decorated method will be called with no arguments by "Get"
1178
711
    and with one argument by "Set".
1179
 
 
 
712
    
1180
713
    The parameters, where they are supported, are the same as
1181
714
    dbus.service.method, except there is only "signature", since the
1182
715
    type from Get() and the type sent to Set() is the same.
1185
718
    # "Set" method, so we fail early here:
1186
719
    if byte_arrays and signature != "ay":
1187
720
        raise ValueError("Byte arrays not supported for non-'ay'"
1188
 
                         " signature {!r}".format(signature))
1189
 
 
 
721
                         " signature %r" % signature)
1190
722
    def decorator(func):
1191
723
        func._dbus_is_property = True
1192
724
        func._dbus_interface = dbus_interface
1195
727
        func._dbus_name = func.__name__
1196
728
        if func._dbus_name.endswith("_dbus_property"):
1197
729
            func._dbus_name = func._dbus_name[:-14]
1198
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1199
 
        return func
1200
 
 
1201
 
    return decorator
1202
 
 
1203
 
 
1204
 
def dbus_interface_annotations(dbus_interface):
1205
 
    """Decorator for marking functions returning interface annotations
1206
 
 
1207
 
    Usage:
1208
 
 
1209
 
    @dbus_interface_annotations("org.example.Interface")
1210
 
    def _foo(self):  # Function name does not matter
1211
 
        return {"org.freedesktop.DBus.Deprecated": "true",
1212
 
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
1213
 
                    "false"}
1214
 
    """
1215
 
 
1216
 
    def decorator(func):
1217
 
        func._dbus_is_interface = True
1218
 
        func._dbus_interface = dbus_interface
1219
 
        func._dbus_name = dbus_interface
1220
 
        return func
1221
 
 
1222
 
    return decorator
1223
 
 
1224
 
 
1225
 
def dbus_annotations(annotations):
1226
 
    """Decorator to annotate D-Bus methods, signals or properties
1227
 
    Usage:
1228
 
 
1229
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1230
 
                       "org.freedesktop.DBus.Property."
1231
 
                       "EmitsChangedSignal": "false"})
1232
 
    @dbus_service_property("org.example.Interface", signature="b",
1233
 
                           access="r")
1234
 
    def Property_dbus_property(self):
1235
 
        return dbus.Boolean(False)
1236
 
 
1237
 
    See also the DBusObjectWithAnnotations class.
1238
 
    """
1239
 
 
1240
 
    def decorator(func):
1241
 
        func._dbus_annotations = annotations
1242
 
        return func
1243
 
 
 
730
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
731
        return func
1244
732
    return decorator
1245
733
 
1246
734
 
1247
735
class DBusPropertyException(dbus.exceptions.DBusException):
1248
736
    """A base class for D-Bus property-related exceptions
1249
737
    """
1250
 
    pass
 
738
    def __unicode__(self):
 
739
        return unicode(str(self))
1251
740
 
1252
741
 
1253
742
class DBusPropertyAccessException(DBusPropertyException):
1262
751
    pass
1263
752
 
1264
753
 
1265
 
class DBusObjectWithAnnotations(dbus.service.Object):
1266
 
    """A D-Bus object with annotations.
1267
 
 
1268
 
    Classes inheriting from this can use the dbus_annotations
1269
 
    decorator to add annotations to methods or signals.
1270
 
    """
1271
 
 
1272
 
    @staticmethod
1273
 
    def _is_dbus_thing(thing):
1274
 
        """Returns a function testing if an attribute is a D-Bus thing
1275
 
 
1276
 
        If called like _is_dbus_thing("method") it returns a function
1277
 
        suitable for use as predicate to inspect.getmembers().
1278
 
        """
1279
 
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1280
 
                                   False)
1281
 
 
1282
 
    def _get_all_dbus_things(self, thing):
1283
 
        """Returns a generator of (name, attribute) pairs
1284
 
        """
1285
 
        return ((getattr(athing.__get__(self), "_dbus_name", name),
1286
 
                 athing.__get__(self))
1287
 
                for cls in self.__class__.__mro__
1288
 
                for name, athing in
1289
 
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
1290
 
 
1291
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1292
 
                         out_signature="s",
1293
 
                         path_keyword='object_path',
1294
 
                         connection_keyword='connection')
1295
 
    def Introspect(self, object_path, connection):
1296
 
        """Overloading of standard D-Bus method.
1297
 
 
1298
 
        Inserts annotation tags on methods and signals.
1299
 
        """
1300
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
1301
 
                                                   connection)
1302
 
        try:
1303
 
            document = xml.dom.minidom.parseString(xmlstring)
1304
 
 
1305
 
            for if_tag in document.getElementsByTagName("interface"):
1306
 
                # Add annotation tags
1307
 
                for typ in ("method", "signal"):
1308
 
                    for tag in if_tag.getElementsByTagName(typ):
1309
 
                        annots = dict()
1310
 
                        for name, prop in (self.
1311
 
                                           _get_all_dbus_things(typ)):
1312
 
                            if (name == tag.getAttribute("name")
1313
 
                                and prop._dbus_interface
1314
 
                                == if_tag.getAttribute("name")):
1315
 
                                annots.update(getattr(
1316
 
                                    prop, "_dbus_annotations", {}))
1317
 
                        for name, value in annots.items():
1318
 
                            ann_tag = document.createElement(
1319
 
                                "annotation")
1320
 
                            ann_tag.setAttribute("name", name)
1321
 
                            ann_tag.setAttribute("value", value)
1322
 
                            tag.appendChild(ann_tag)
1323
 
                # Add interface annotation tags
1324
 
                for annotation, value in dict(
1325
 
                    itertools.chain.from_iterable(
1326
 
                        annotations().items()
1327
 
                        for name, annotations
1328
 
                        in self._get_all_dbus_things("interface")
1329
 
                        if name == if_tag.getAttribute("name")
1330
 
                        )).items():
1331
 
                    ann_tag = document.createElement("annotation")
1332
 
                    ann_tag.setAttribute("name", annotation)
1333
 
                    ann_tag.setAttribute("value", value)
1334
 
                    if_tag.appendChild(ann_tag)
1335
 
                # Fix argument name for the Introspect method itself
1336
 
                if (if_tag.getAttribute("name")
1337
 
                    == dbus.INTROSPECTABLE_IFACE):
1338
 
                    for cn in if_tag.getElementsByTagName("method"):
1339
 
                        if cn.getAttribute("name") == "Introspect":
1340
 
                            for arg in cn.getElementsByTagName("arg"):
1341
 
                                if (arg.getAttribute("direction")
1342
 
                                    == "out"):
1343
 
                                    arg.setAttribute("name",
1344
 
                                                     "xml_data")
1345
 
            xmlstring = document.toxml("utf-8")
1346
 
            document.unlink()
1347
 
        except (AttributeError, xml.dom.DOMException,
1348
 
                xml.parsers.expat.ExpatError) as error:
1349
 
            logger.error("Failed to override Introspection method",
1350
 
                         exc_info=error)
1351
 
        return xmlstring
1352
 
 
1353
 
 
1354
 
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
754
class DBusObjectWithProperties(dbus.service.Object):
1355
755
    """A D-Bus object with properties.
1356
 
 
 
756
    
1357
757
    Classes inheriting from this can use the dbus_service_property
1358
758
    decorator to expose methods as D-Bus properties.  It exposes the
1359
759
    standard Get(), Set(), and GetAll() methods on the D-Bus.
1360
760
    """
1361
 
 
 
761
    
 
762
    @staticmethod
 
763
    def _is_dbus_property(obj):
 
764
        return getattr(obj, "_dbus_is_property", False)
 
765
    
 
766
    def _get_all_dbus_properties(self):
 
767
        """Returns a generator of (name, attribute) pairs
 
768
        """
 
769
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
770
                for cls in self.__class__.__mro__
 
771
                for name, prop in
 
772
                inspect.getmembers(cls, self._is_dbus_property))
 
773
    
1362
774
    def _get_dbus_property(self, interface_name, property_name):
1363
775
        """Returns a bound method if one exists which is a D-Bus
1364
776
        property with the specified name and interface.
1365
777
        """
1366
 
        for cls in self.__class__.__mro__:
1367
 
            for name, value in inspect.getmembers(
1368
 
                    cls, self._is_dbus_thing("property")):
 
778
        for cls in  self.__class__.__mro__:
 
779
            for name, value in (inspect.getmembers
 
780
                                (cls, self._is_dbus_property)):
1369
781
                if (value._dbus_name == property_name
1370
782
                    and value._dbus_interface == interface_name):
1371
783
                    return value.__get__(self)
1372
 
 
 
784
        
1373
785
        # No such property
1374
 
        raise DBusPropertyNotFound("{}:{}.{}".format(
1375
 
            self.dbus_object_path, interface_name, property_name))
1376
 
 
1377
 
    @classmethod
1378
 
    def _get_all_interface_names(cls):
1379
 
        """Get a sequence of all interfaces supported by an object"""
1380
 
        return (name for name in set(getattr(getattr(x, attr),
1381
 
                                             "_dbus_interface", None)
1382
 
                                     for x in (inspect.getmro(cls))
1383
 
                                     for attr in dir(x))
1384
 
                if name is not None)
1385
 
 
1386
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1387
 
                         in_signature="ss",
 
786
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
787
                                   + interface_name + "."
 
788
                                   + property_name)
 
789
    
 
790
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1388
791
                         out_signature="v")
1389
792
    def Get(self, interface_name, property_name):
1390
793
        """Standard D-Bus property Get() method, see D-Bus standard.
1396
799
        if not hasattr(value, "variant_level"):
1397
800
            return value
1398
801
        return type(value)(value, variant_level=value.variant_level+1)
1399
 
 
 
802
    
1400
803
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1401
804
    def Set(self, interface_name, property_name, value):
1402
805
        """Standard D-Bus property Set() method, see D-Bus standard.
1408
811
            # The byte_arrays option is not supported yet on
1409
812
            # signatures other than "ay".
1410
813
            if prop._dbus_signature != "ay":
1411
 
                raise ValueError("Byte arrays not supported for non-"
1412
 
                                 "'ay' signature {!r}"
1413
 
                                 .format(prop._dbus_signature))
1414
 
            value = dbus.ByteArray(bytes(value))
 
814
                raise ValueError
 
815
            value = dbus.ByteArray(''.join(unichr(byte)
 
816
                                           for byte in value))
1415
817
        prop(value)
1416
 
 
1417
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1418
 
                         in_signature="s",
 
818
    
 
819
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1419
820
                         out_signature="a{sv}")
1420
821
    def GetAll(self, interface_name):
1421
822
        """Standard D-Bus property GetAll() method, see D-Bus
1422
823
        standard.
1423
 
 
 
824
        
1424
825
        Note: Will not include properties with access="write".
1425
826
        """
1426
827
        properties = {}
1427
 
        for name, prop in self._get_all_dbus_things("property"):
 
828
        for name, prop in self._get_all_dbus_properties():
1428
829
            if (interface_name
1429
830
                and interface_name != prop._dbus_interface):
1430
831
                # Interface non-empty but did not match
1436
837
            if not hasattr(value, "variant_level"):
1437
838
                properties[name] = value
1438
839
                continue
1439
 
            properties[name] = type(value)(
1440
 
                value, variant_level=value.variant_level + 1)
 
840
            properties[name] = type(value)(value, variant_level=
 
841
                                           value.variant_level+1)
1441
842
        return dbus.Dictionary(properties, signature="sv")
1442
 
 
1443
 
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1444
 
    def PropertiesChanged(self, interface_name, changed_properties,
1445
 
                          invalidated_properties):
1446
 
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
1447
 
        standard.
1448
 
        """
1449
 
        pass
1450
 
 
 
843
    
1451
844
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1452
845
                         out_signature="s",
1453
846
                         path_keyword='object_path',
1454
847
                         connection_keyword='connection')
1455
848
    def Introspect(self, object_path, connection):
1456
 
        """Overloading of standard D-Bus method.
1457
 
 
1458
 
        Inserts property tags and interface annotation tags.
 
849
        """Standard D-Bus method, overloaded to insert property tags.
1459
850
        """
1460
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1461
 
                                                         object_path,
1462
 
                                                         connection)
 
851
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
852
                                                   connection)
1463
853
        try:
1464
854
            document = xml.dom.minidom.parseString(xmlstring)
1465
 
 
1466
855
            def make_tag(document, name, prop):
1467
856
                e = document.createElement("property")
1468
857
                e.setAttribute("name", name)
1469
858
                e.setAttribute("type", prop._dbus_signature)
1470
859
                e.setAttribute("access", prop._dbus_access)
1471
860
                return e
1472
 
 
1473
861
            for if_tag in document.getElementsByTagName("interface"):
1474
 
                # Add property tags
1475
862
                for tag in (make_tag(document, name, prop)
1476
863
                            for name, prop
1477
 
                            in self._get_all_dbus_things("property")
 
864
                            in self._get_all_dbus_properties()
1478
865
                            if prop._dbus_interface
1479
866
                            == if_tag.getAttribute("name")):
1480
867
                    if_tag.appendChild(tag)
1481
 
                # Add annotation tags for properties
1482
 
                for tag in if_tag.getElementsByTagName("property"):
1483
 
                    annots = dict()
1484
 
                    for name, prop in self._get_all_dbus_things(
1485
 
                            "property"):
1486
 
                        if (name == tag.getAttribute("name")
1487
 
                            and prop._dbus_interface
1488
 
                            == if_tag.getAttribute("name")):
1489
 
                            annots.update(getattr(
1490
 
                                prop, "_dbus_annotations", {}))
1491
 
                    for name, value in annots.items():
1492
 
                        ann_tag = document.createElement(
1493
 
                            "annotation")
1494
 
                        ann_tag.setAttribute("name", name)
1495
 
                        ann_tag.setAttribute("value", value)
1496
 
                        tag.appendChild(ann_tag)
1497
868
                # Add the names to the return values for the
1498
869
                # "org.freedesktop.DBus.Properties" methods
1499
870
                if (if_tag.getAttribute("name")
1514
885
        except (AttributeError, xml.dom.DOMException,
1515
886
                xml.parsers.expat.ExpatError) as error:
1516
887
            logger.error("Failed to override Introspection method",
1517
 
                         exc_info=error)
1518
 
        return xmlstring
1519
 
 
1520
 
 
1521
 
try:
1522
 
    dbus.OBJECT_MANAGER_IFACE
1523
 
except AttributeError:
1524
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1525
 
 
1526
 
 
1527
 
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1528
 
    """A D-Bus object with an ObjectManager.
1529
 
 
1530
 
    Classes inheriting from this exposes the standard
1531
 
    GetManagedObjects call and the InterfacesAdded and
1532
 
    InterfacesRemoved signals on the standard
1533
 
    "org.freedesktop.DBus.ObjectManager" interface.
1534
 
 
1535
 
    Note: No signals are sent automatically; they must be sent
1536
 
    manually.
1537
 
    """
1538
 
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1539
 
                         out_signature="a{oa{sa{sv}}}")
1540
 
    def GetManagedObjects(self):
1541
 
        """This function must be overridden"""
1542
 
        raise NotImplementedError()
1543
 
 
1544
 
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1545
 
                         signature="oa{sa{sv}}")
1546
 
    def InterfacesAdded(self, object_path, interfaces_and_properties):
1547
 
        pass
1548
 
 
1549
 
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1550
 
    def InterfacesRemoved(self, object_path, interfaces):
1551
 
        pass
1552
 
 
1553
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1554
 
                         out_signature="s",
1555
 
                         path_keyword='object_path',
1556
 
                         connection_keyword='connection')
1557
 
    def Introspect(self, object_path, connection):
1558
 
        """Overloading of standard D-Bus method.
1559
 
 
1560
 
        Override return argument name of GetManagedObjects to be
1561
 
        "objpath_interfaces_and_properties"
1562
 
        """
1563
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1564
 
                                                         object_path,
1565
 
                                                         connection)
1566
 
        try:
1567
 
            document = xml.dom.minidom.parseString(xmlstring)
1568
 
 
1569
 
            for if_tag in document.getElementsByTagName("interface"):
1570
 
                # Fix argument name for the GetManagedObjects method
1571
 
                if (if_tag.getAttribute("name")
1572
 
                    == dbus.OBJECT_MANAGER_IFACE):
1573
 
                    for cn in if_tag.getElementsByTagName("method"):
1574
 
                        if (cn.getAttribute("name")
1575
 
                            == "GetManagedObjects"):
1576
 
                            for arg in cn.getElementsByTagName("arg"):
1577
 
                                if (arg.getAttribute("direction")
1578
 
                                    == "out"):
1579
 
                                    arg.setAttribute(
1580
 
                                        "name",
1581
 
                                        "objpath_interfaces"
1582
 
                                        "_and_properties")
1583
 
            xmlstring = document.toxml("utf-8")
1584
 
            document.unlink()
1585
 
        except (AttributeError, xml.dom.DOMException,
1586
 
                xml.parsers.expat.ExpatError) as error:
1587
 
            logger.error("Failed to override Introspection method",
1588
 
                         exc_info=error)
1589
 
        return xmlstring
1590
 
 
1591
 
 
1592
 
def datetime_to_dbus(dt, variant_level=0):
 
888
                         error)
 
889
        return xmlstring
 
890
 
 
891
 
 
892
def datetime_to_dbus (dt, variant_level=0):
1593
893
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1594
894
    if dt is None:
1595
 
        return dbus.String("", variant_level=variant_level)
1596
 
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1597
 
 
1598
 
 
1599
 
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1600
 
    """A class decorator; applied to a subclass of
1601
 
    dbus.service.Object, it will add alternate D-Bus attributes with
1602
 
    interface names according to the "alt_interface_names" mapping.
1603
 
    Usage:
1604
 
 
1605
 
    @alternate_dbus_interfaces({"org.example.Interface":
1606
 
                                    "net.example.AlternateInterface"})
1607
 
    class SampleDBusObject(dbus.service.Object):
1608
 
        @dbus.service.method("org.example.Interface")
1609
 
        def SampleDBusMethod():
1610
 
            pass
1611
 
 
1612
 
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1613
 
    reachable via two interfaces: "org.example.Interface" and
1614
 
    "net.example.AlternateInterface", the latter of which will have
1615
 
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1616
 
    "true", unless "deprecate" is passed with a False value.
1617
 
 
1618
 
    This works for methods and signals, and also for D-Bus properties
1619
 
    (from DBusObjectWithProperties) and interfaces (from the
1620
 
    dbus_interface_annotations decorator).
 
895
        return dbus.String("", variant_level = variant_level)
 
896
    return dbus.String(dt.isoformat(),
 
897
                       variant_level=variant_level)
 
898
 
 
899
 
 
900
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
901
                                  .__metaclass__):
 
902
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
903
    will add additional D-Bus attributes matching a certain pattern.
1621
904
    """
1622
 
 
1623
 
    def wrapper(cls):
1624
 
        for orig_interface_name, alt_interface_name in (
1625
 
                alt_interface_names.items()):
1626
 
            attr = {}
1627
 
            interface_names = set()
1628
 
            # Go though all attributes of the class
1629
 
            for attrname, attribute in inspect.getmembers(cls):
 
905
    def __new__(mcs, name, bases, attr):
 
906
        # Go through all the base classes which could have D-Bus
 
907
        # methods, signals, or properties in them
 
908
        for base in (b for b in bases
 
909
                     if issubclass(b, dbus.service.Object)):
 
910
            # Go though all attributes of the base class
 
911
            for attrname, attribute in inspect.getmembers(base):
1630
912
                # Ignore non-D-Bus attributes, and D-Bus attributes
1631
913
                # with the wrong interface name
1632
914
                if (not hasattr(attribute, "_dbus_interface")
1633
 
                    or not attribute._dbus_interface.startswith(
1634
 
                        orig_interface_name)):
 
915
                    or not attribute._dbus_interface
 
916
                    .startswith("se.recompile.Mandos")):
1635
917
                    continue
1636
918
                # Create an alternate D-Bus interface name based on
1637
919
                # the current name
1638
 
                alt_interface = attribute._dbus_interface.replace(
1639
 
                    orig_interface_name, alt_interface_name)
1640
 
                interface_names.add(alt_interface)
 
920
                alt_interface = (attribute._dbus_interface
 
921
                                 .replace("se.recompile.Mandos",
 
922
                                          "se.bsnet.fukt.Mandos"))
1641
923
                # Is this a D-Bus signal?
1642
924
                if getattr(attribute, "_dbus_is_signal", False):
1643
 
                    # Extract the original non-method undecorated
1644
 
                    # function by black magic
1645
 
                    if sys.version_info.major == 2:
1646
 
                        nonmethod_func = (dict(
 
925
                    # Extract the original non-method function by
 
926
                    # black magic
 
927
                    nonmethod_func = (dict(
1647
928
                            zip(attribute.func_code.co_freevars,
1648
 
                                attribute.__closure__))
1649
 
                                          ["func"].cell_contents)
1650
 
                    else:
1651
 
                        nonmethod_func = (dict(
1652
 
                            zip(attribute.__code__.co_freevars,
1653
 
                                attribute.__closure__))
1654
 
                                          ["func"].cell_contents)
 
929
                                attribute.__closure__))["func"]
 
930
                                      .cell_contents)
1655
931
                    # Create a new, but exactly alike, function
1656
932
                    # object, and decorate it to be a new D-Bus signal
1657
933
                    # with the alternate D-Bus interface name
1658
 
                    new_function = copy_function(nonmethod_func)
1659
 
                    new_function = (dbus.service.signal(
1660
 
                        alt_interface,
1661
 
                        attribute._dbus_signature)(new_function))
1662
 
                    # Copy annotations, if any
1663
 
                    try:
1664
 
                        new_function._dbus_annotations = dict(
1665
 
                            attribute._dbus_annotations)
1666
 
                    except AttributeError:
1667
 
                        pass
1668
 
 
 
934
                    new_function = (dbus.service.signal
 
935
                                    (alt_interface,
 
936
                                     attribute._dbus_signature)
 
937
                                    (types.FunctionType(
 
938
                                nonmethod_func.func_code,
 
939
                                nonmethod_func.func_globals,
 
940
                                nonmethod_func.func_name,
 
941
                                nonmethod_func.func_defaults,
 
942
                                nonmethod_func.func_closure)))
1669
943
                    # Define a creator of a function to call both the
1670
 
                    # original and alternate functions, so both the
1671
 
                    # original and alternate signals gets sent when
1672
 
                    # the function is called
 
944
                    # old and new functions, so both the old and new
 
945
                    # signals gets sent when the function is called
1673
946
                    def fixscope(func1, func2):
1674
947
                        """This function is a scope container to pass
1675
948
                        func1 and func2 to the "call_both" function
1676
949
                        outside of its arguments"""
1677
 
 
1678
 
                        @functools.wraps(func2)
1679
950
                        def call_both(*args, **kwargs):
1680
951
                            """This function will emit two D-Bus
1681
952
                            signals by calling func1 and func2"""
1682
953
                            func1(*args, **kwargs)
1683
954
                            func2(*args, **kwargs)
1684
 
                        # Make wrapper function look like a D-Bus
1685
 
                        # signal
1686
 
                        for name, attr in inspect.getmembers(func2):
1687
 
                            if name.startswith("_dbus_"):
1688
 
                                setattr(call_both, name, attr)
1689
 
 
1690
955
                        return call_both
1691
956
                    # Create the "call_both" function and add it to
1692
957
                    # the class
1693
 
                    attr[attrname] = fixscope(attribute, new_function)
 
958
                    attr[attrname] = fixscope(attribute,
 
959
                                              new_function)
1694
960
                # Is this a D-Bus method?
1695
961
                elif getattr(attribute, "_dbus_is_method", False):
1696
962
                    # Create a new, but exactly alike, function
1697
963
                    # object.  Decorate it to be a new D-Bus method
1698
964
                    # with the alternate D-Bus interface name.  Add it
1699
965
                    # to the class.
1700
 
                    attr[attrname] = (
1701
 
                        dbus.service.method(
1702
 
                            alt_interface,
1703
 
                            attribute._dbus_in_signature,
1704
 
                            attribute._dbus_out_signature)
1705
 
                        (copy_function(attribute)))
1706
 
                    # Copy annotations, if any
1707
 
                    try:
1708
 
                        attr[attrname]._dbus_annotations = dict(
1709
 
                            attribute._dbus_annotations)
1710
 
                    except AttributeError:
1711
 
                        pass
 
966
                    attr[attrname] = (dbus.service.method
 
967
                                      (alt_interface,
 
968
                                       attribute._dbus_in_signature,
 
969
                                       attribute._dbus_out_signature)
 
970
                                      (types.FunctionType
 
971
                                       (attribute.func_code,
 
972
                                        attribute.func_globals,
 
973
                                        attribute.func_name,
 
974
                                        attribute.func_defaults,
 
975
                                        attribute.func_closure)))
1712
976
                # Is this a D-Bus property?
1713
977
                elif getattr(attribute, "_dbus_is_property", False):
1714
978
                    # Create a new, but exactly alike, function
1715
979
                    # object, and decorate it to be a new D-Bus
1716
980
                    # property with the alternate D-Bus interface
1717
981
                    # name.  Add it to the class.
1718
 
                    attr[attrname] = (dbus_service_property(
1719
 
                        alt_interface, attribute._dbus_signature,
1720
 
                        attribute._dbus_access,
1721
 
                        attribute._dbus_get_args_options
1722
 
                        ["byte_arrays"])
1723
 
                                      (copy_function(attribute)))
1724
 
                    # Copy annotations, if any
1725
 
                    try:
1726
 
                        attr[attrname]._dbus_annotations = dict(
1727
 
                            attribute._dbus_annotations)
1728
 
                    except AttributeError:
1729
 
                        pass
1730
 
                # Is this a D-Bus interface?
1731
 
                elif getattr(attribute, "_dbus_is_interface", False):
1732
 
                    # Create a new, but exactly alike, function
1733
 
                    # object.  Decorate it to be a new D-Bus interface
1734
 
                    # with the alternate D-Bus interface name.  Add it
1735
 
                    # to the class.
1736
 
                    attr[attrname] = (
1737
 
                        dbus_interface_annotations(alt_interface)
1738
 
                        (copy_function(attribute)))
1739
 
            if deprecate:
1740
 
                # Deprecate all alternate interfaces
1741
 
                iname = "_AlternateDBusNames_interface_annotation{}"
1742
 
                for interface_name in interface_names:
1743
 
 
1744
 
                    @dbus_interface_annotations(interface_name)
1745
 
                    def func(self):
1746
 
                        return {"org.freedesktop.DBus.Deprecated":
1747
 
                                "true"}
1748
 
                    # Find an unused name
1749
 
                    for aname in (iname.format(i)
1750
 
                                  for i in itertools.count()):
1751
 
                        if aname not in attr:
1752
 
                            attr[aname] = func
1753
 
                            break
1754
 
            if interface_names:
1755
 
                # Replace the class with a new subclass of it with
1756
 
                # methods, signals, etc. as created above.
1757
 
                if sys.version_info.major == 2:
1758
 
                    cls = type(b"{}Alternate".format(cls.__name__),
1759
 
                               (cls, ), attr)
1760
 
                else:
1761
 
                    cls = type("{}Alternate".format(cls.__name__),
1762
 
                               (cls, ), attr)
1763
 
        return cls
1764
 
 
1765
 
    return wrapper
1766
 
 
1767
 
 
1768
 
@alternate_dbus_interfaces({"se.recompile.Mandos":
1769
 
                            "se.bsnet.fukt.Mandos"})
 
982
                    attr[attrname] = (dbus_service_property
 
983
                                      (alt_interface,
 
984
                                       attribute._dbus_signature,
 
985
                                       attribute._dbus_access,
 
986
                                       attribute
 
987
                                       ._dbus_get_args_options
 
988
                                       ["byte_arrays"])
 
989
                                      (types.FunctionType
 
990
                                       (attribute.func_code,
 
991
                                        attribute.func_globals,
 
992
                                        attribute.func_name,
 
993
                                        attribute.func_defaults,
 
994
                                        attribute.func_closure)))
 
995
        return type.__new__(mcs, name, bases, attr)
 
996
 
 
997
 
1770
998
class ClientDBus(Client, DBusObjectWithProperties):
1771
999
    """A Client class using D-Bus
1772
 
 
 
1000
    
1773
1001
    Attributes:
1774
1002
    dbus_object_path: dbus.ObjectPath
1775
1003
    bus: dbus.SystemBus()
1776
1004
    """
1777
 
 
 
1005
    
1778
1006
    runtime_expansions = (Client.runtime_expansions
1779
 
                          + ("dbus_object_path", ))
1780
 
 
1781
 
    _interface = "se.recompile.Mandos.Client"
1782
 
 
 
1007
                          + ("dbus_object_path",))
 
1008
    
1783
1009
    # dbus.service.Object doesn't use super(), so we can't either.
1784
 
 
1785
 
    def __init__(self, bus=None, *args, **kwargs):
 
1010
    
 
1011
    def __init__(self, bus = None, *args, **kwargs):
1786
1012
        self.bus = bus
1787
1013
        Client.__init__(self, *args, **kwargs)
 
1014
        
 
1015
        self._approvals_pending = 0
1788
1016
        # Only now, when this client is initialized, can it show up on
1789
1017
        # the D-Bus
1790
 
        client_object_name = str(self.name).translate(
 
1018
        client_object_name = unicode(self.name).translate(
1791
1019
            {ord("."): ord("_"),
1792
1020
             ord("-"): ord("_")})
1793
 
        self.dbus_object_path = dbus.ObjectPath(
1794
 
            "/clients/" + client_object_name)
 
1021
        self.dbus_object_path = (dbus.ObjectPath
 
1022
                                 ("/clients/" + client_object_name))
1795
1023
        DBusObjectWithProperties.__init__(self, self.bus,
1796
1024
                                          self.dbus_object_path)
1797
 
 
1798
 
    def notifychangeproperty(transform_func, dbus_name,
1799
 
                             type_func=lambda x: x,
1800
 
                             variant_level=1,
1801
 
                             invalidate_only=False,
1802
 
                             _interface=_interface):
 
1025
        
 
1026
    def notifychangeproperty(transform_func,
 
1027
                             dbus_name, type_func=lambda x: x,
 
1028
                             variant_level=1):
1803
1029
        """ Modify a variable so that it's a property which announces
1804
1030
        its changes to DBus.
1805
 
 
 
1031
        
1806
1032
        transform_fun: Function that takes a value and a variant_level
1807
1033
                       and transforms it to a D-Bus type.
1808
1034
        dbus_name: D-Bus name of the variable
1810
1036
                   to the D-Bus.  Default: no transform
1811
1037
        variant_level: D-Bus variant level.  Default: 1
1812
1038
        """
1813
 
        attrname = "_{}".format(dbus_name)
1814
 
 
 
1039
        attrname = "_{0}".format(dbus_name)
1815
1040
        def setter(self, value):
1816
1041
            if hasattr(self, "dbus_object_path"):
1817
1042
                if (not hasattr(self, attrname) or
1818
1043
                    type_func(getattr(self, attrname, None))
1819
1044
                    != type_func(value)):
1820
 
                    if invalidate_only:
1821
 
                        self.PropertiesChanged(
1822
 
                            _interface, dbus.Dictionary(),
1823
 
                            dbus.Array((dbus_name, )))
1824
 
                    else:
1825
 
                        dbus_value = transform_func(
1826
 
                            type_func(value),
1827
 
                            variant_level=variant_level)
1828
 
                        self.PropertyChanged(dbus.String(dbus_name),
1829
 
                                             dbus_value)
1830
 
                        self.PropertiesChanged(
1831
 
                            _interface,
1832
 
                            dbus.Dictionary({dbus.String(dbus_name):
1833
 
                                             dbus_value}),
1834
 
                            dbus.Array())
 
1045
                    dbus_value = transform_func(type_func(value),
 
1046
                                                variant_level
 
1047
                                                =variant_level)
 
1048
                    self.PropertyChanged(dbus.String(dbus_name),
 
1049
                                         dbus_value)
1835
1050
            setattr(self, attrname, value)
1836
 
 
 
1051
        
1837
1052
        return property(lambda self: getattr(self, attrname), setter)
1838
 
 
 
1053
    
 
1054
    
1839
1055
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1840
1056
    approvals_pending = notifychangeproperty(dbus.Boolean,
1841
1057
                                             "ApprovalPending",
1842
 
                                             type_func=bool)
 
1058
                                             type_func = bool)
1843
1059
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1844
1060
    last_enabled = notifychangeproperty(datetime_to_dbus,
1845
1061
                                        "LastEnabled")
1846
 
    checker = notifychangeproperty(
1847
 
        dbus.Boolean, "CheckerRunning",
1848
 
        type_func=lambda checker: checker is not None)
 
1062
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1063
                                   type_func = lambda checker:
 
1064
                                       checker is not None)
1849
1065
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1850
1066
                                           "LastCheckedOK")
1851
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1852
 
                                               "LastCheckerStatus")
1853
1067
    last_approval_request = notifychangeproperty(
1854
1068
        datetime_to_dbus, "LastApprovalRequest")
1855
1069
    approved_by_default = notifychangeproperty(dbus.Boolean,
1856
1070
                                               "ApprovedByDefault")
1857
 
    approval_delay = notifychangeproperty(
1858
 
        dbus.UInt64, "ApprovalDelay",
1859
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1071
    approval_delay = notifychangeproperty(dbus.UInt16,
 
1072
                                          "ApprovalDelay",
 
1073
                                          type_func =
 
1074
                                          _timedelta_to_milliseconds)
1860
1075
    approval_duration = notifychangeproperty(
1861
 
        dbus.UInt64, "ApprovalDuration",
1862
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1076
        dbus.UInt16, "ApprovalDuration",
 
1077
        type_func = _timedelta_to_milliseconds)
1863
1078
    host = notifychangeproperty(dbus.String, "Host")
1864
 
    timeout = notifychangeproperty(
1865
 
        dbus.UInt64, "Timeout",
1866
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1079
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
 
1080
                                   type_func =
 
1081
                                   _timedelta_to_milliseconds)
1867
1082
    extended_timeout = notifychangeproperty(
1868
 
        dbus.UInt64, "ExtendedTimeout",
1869
 
        type_func=lambda td: td.total_seconds() * 1000)
1870
 
    interval = notifychangeproperty(
1871
 
        dbus.UInt64, "Interval",
1872
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1083
        dbus.UInt16, "ExtendedTimeout",
 
1084
        type_func = _timedelta_to_milliseconds)
 
1085
    interval = notifychangeproperty(dbus.UInt16,
 
1086
                                    "Interval",
 
1087
                                    type_func =
 
1088
                                    _timedelta_to_milliseconds)
1873
1089
    checker_command = notifychangeproperty(dbus.String, "Checker")
1874
 
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1875
 
                                  invalidate_only=True)
1876
 
 
 
1090
    
1877
1091
    del notifychangeproperty
1878
 
 
 
1092
    
1879
1093
    def __del__(self, *args, **kwargs):
1880
1094
        try:
1881
1095
            self.remove_from_connection()
1884
1098
        if hasattr(DBusObjectWithProperties, "__del__"):
1885
1099
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1886
1100
        Client.__del__(self, *args, **kwargs)
1887
 
 
1888
 
    def checker_callback(self, source, condition,
1889
 
                         connection, command, *args, **kwargs):
1890
 
        ret = Client.checker_callback(self, source, condition,
1891
 
                                      connection, command, *args,
1892
 
                                      **kwargs)
1893
 
        exitstatus = self.last_checker_status
1894
 
        if exitstatus >= 0:
 
1101
    
 
1102
    def checker_callback(self, pid, condition, command,
 
1103
                         *args, **kwargs):
 
1104
        self.checker_callback_tag = None
 
1105
        self.checker = None
 
1106
        if os.WIFEXITED(condition):
 
1107
            exitstatus = os.WEXITSTATUS(condition)
1895
1108
            # Emit D-Bus signal
1896
1109
            self.CheckerCompleted(dbus.Int16(exitstatus),
1897
 
                                  # This is specific to GNU libC
1898
 
                                  dbus.Int64(exitstatus << 8),
 
1110
                                  dbus.Int64(condition),
1899
1111
                                  dbus.String(command))
1900
1112
        else:
1901
1113
            # Emit D-Bus signal
1902
1114
            self.CheckerCompleted(dbus.Int16(-1),
1903
 
                                  dbus.Int64(
1904
 
                                      # This is specific to GNU libC
1905
 
                                      (exitstatus << 8)
1906
 
                                      | self.last_checker_signal),
 
1115
                                  dbus.Int64(condition),
1907
1116
                                  dbus.String(command))
1908
 
        return ret
1909
 
 
 
1117
        
 
1118
        return Client.checker_callback(self, pid, condition, command,
 
1119
                                       *args, **kwargs)
 
1120
    
1910
1121
    def start_checker(self, *args, **kwargs):
1911
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
1122
        old_checker = self.checker
 
1123
        if self.checker is not None:
 
1124
            old_checker_pid = self.checker.pid
 
1125
        else:
 
1126
            old_checker_pid = None
1912
1127
        r = Client.start_checker(self, *args, **kwargs)
1913
1128
        # Only if new checker process was started
1914
1129
        if (self.checker is not None
1916
1131
            # Emit D-Bus signal
1917
1132
            self.CheckerStarted(self.current_checker_command)
1918
1133
        return r
1919
 
 
 
1134
    
1920
1135
    def _reset_approved(self):
1921
 
        self.approved = None
 
1136
        self._approved = None
1922
1137
        return False
1923
 
 
 
1138
    
1924
1139
    def approve(self, value=True):
1925
 
        self.approved = value
1926
 
        GLib.timeout_add(int(self.approval_duration.total_seconds()
1927
 
                             * 1000), self._reset_approved)
1928
1140
        self.send_changedstate()
1929
 
 
1930
 
    #  D-Bus methods, signals & properties
1931
 
 
1932
 
    #  Interfaces
1933
 
 
1934
 
    #  Signals
1935
 
 
 
1141
        self._approved = value
 
1142
        gobject.timeout_add(_timedelta_to_milliseconds
 
1143
                            (self.approval_duration),
 
1144
                            self._reset_approved)
 
1145
    
 
1146
    
 
1147
    ## D-Bus methods, signals & properties
 
1148
    _interface = "se.recompile.Mandos.Client"
 
1149
    
 
1150
    ## Signals
 
1151
    
1936
1152
    # CheckerCompleted - signal
1937
1153
    @dbus.service.signal(_interface, signature="nxs")
1938
1154
    def CheckerCompleted(self, exitcode, waitstatus, command):
1939
1155
        "D-Bus signal"
1940
1156
        pass
1941
 
 
 
1157
    
1942
1158
    # CheckerStarted - signal
1943
1159
    @dbus.service.signal(_interface, signature="s")
1944
1160
    def CheckerStarted(self, command):
1945
1161
        "D-Bus signal"
1946
1162
        pass
1947
 
 
 
1163
    
1948
1164
    # PropertyChanged - signal
1949
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1950
1165
    @dbus.service.signal(_interface, signature="sv")
1951
1166
    def PropertyChanged(self, property, value):
1952
1167
        "D-Bus signal"
1953
1168
        pass
1954
 
 
 
1169
    
1955
1170
    # GotSecret - signal
1956
1171
    @dbus.service.signal(_interface)
1957
1172
    def GotSecret(self):
1960
1175
        server to mandos-client
1961
1176
        """
1962
1177
        pass
1963
 
 
 
1178
    
1964
1179
    # Rejected - signal
1965
1180
    @dbus.service.signal(_interface, signature="s")
1966
1181
    def Rejected(self, reason):
1967
1182
        "D-Bus signal"
1968
1183
        pass
1969
 
 
 
1184
    
1970
1185
    # NeedApproval - signal
1971
1186
    @dbus.service.signal(_interface, signature="tb")
1972
1187
    def NeedApproval(self, timeout, default):
1973
1188
        "D-Bus signal"
1974
1189
        return self.need_approval()
1975
 
 
1976
 
    #  Methods
1977
 
 
 
1190
    
 
1191
    # NeRwequest - signal
 
1192
    @dbus.service.signal(_interface, signature="s")
 
1193
    def NewRequest(self, ip):
 
1194
        """D-Bus signal
 
1195
        Is sent after a client request a password.
 
1196
        """
 
1197
        pass
 
1198
    
 
1199
    ## Methods
 
1200
    
1978
1201
    # Approve - method
1979
1202
    @dbus.service.method(_interface, in_signature="b")
1980
1203
    def Approve(self, value):
1981
1204
        self.approve(value)
1982
 
 
 
1205
    
1983
1206
    # CheckedOK - method
1984
1207
    @dbus.service.method(_interface)
1985
1208
    def CheckedOK(self):
1986
1209
        self.checked_ok()
1987
 
 
 
1210
    
1988
1211
    # Enable - method
1989
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1990
1212
    @dbus.service.method(_interface)
1991
1213
    def Enable(self):
1992
1214
        "D-Bus method"
1993
1215
        self.enable()
1994
 
 
 
1216
    
1995
1217
    # StartChecker - method
1996
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
1218
    @dbus.service.method(_interface)
1998
1219
    def StartChecker(self):
1999
1220
        "D-Bus method"
2000
1221
        self.start_checker()
2001
 
 
 
1222
    
2002
1223
    # Disable - method
2003
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2004
1224
    @dbus.service.method(_interface)
2005
1225
    def Disable(self):
2006
1226
        "D-Bus method"
2007
1227
        self.disable()
2008
 
 
 
1228
    
2009
1229
    # StopChecker - method
2010
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2011
1230
    @dbus.service.method(_interface)
2012
1231
    def StopChecker(self):
2013
1232
        self.stop_checker()
2014
 
 
2015
 
    #  Properties
2016
 
 
 
1233
    
 
1234
    ## Properties
 
1235
    
2017
1236
    # ApprovalPending - property
2018
1237
    @dbus_service_property(_interface, signature="b", access="read")
2019
1238
    def ApprovalPending_dbus_property(self):
2020
1239
        return dbus.Boolean(bool(self.approvals_pending))
2021
 
 
 
1240
    
2022
1241
    # ApprovedByDefault - property
2023
 
    @dbus_service_property(_interface,
2024
 
                           signature="b",
 
1242
    @dbus_service_property(_interface, signature="b",
2025
1243
                           access="readwrite")
2026
1244
    def ApprovedByDefault_dbus_property(self, value=None):
2027
1245
        if value is None:       # get
2028
1246
            return dbus.Boolean(self.approved_by_default)
2029
1247
        self.approved_by_default = bool(value)
2030
 
 
 
1248
    
2031
1249
    # ApprovalDelay - property
2032
 
    @dbus_service_property(_interface,
2033
 
                           signature="t",
 
1250
    @dbus_service_property(_interface, signature="t",
2034
1251
                           access="readwrite")
2035
1252
    def ApprovalDelay_dbus_property(self, value=None):
2036
1253
        if value is None:       # get
2037
 
            return dbus.UInt64(self.approval_delay.total_seconds()
2038
 
                               * 1000)
 
1254
            return dbus.UInt64(self.approval_delay_milliseconds())
2039
1255
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
2040
 
 
 
1256
    
2041
1257
    # ApprovalDuration - property
2042
 
    @dbus_service_property(_interface,
2043
 
                           signature="t",
 
1258
    @dbus_service_property(_interface, signature="t",
2044
1259
                           access="readwrite")
2045
1260
    def ApprovalDuration_dbus_property(self, value=None):
2046
1261
        if value is None:       # get
2047
 
            return dbus.UInt64(self.approval_duration.total_seconds()
2048
 
                               * 1000)
 
1262
            return dbus.UInt64(_timedelta_to_milliseconds(
 
1263
                    self.approval_duration))
2049
1264
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
2050
 
 
 
1265
    
2051
1266
    # Name - property
2052
 
    @dbus_annotations(
2053
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2054
1267
    @dbus_service_property(_interface, signature="s", access="read")
2055
1268
    def Name_dbus_property(self):
2056
1269
        return dbus.String(self.name)
2057
 
 
2058
 
    # KeyID - property
2059
 
    @dbus_annotations(
2060
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2061
 
    @dbus_service_property(_interface, signature="s", access="read")
2062
 
    def KeyID_dbus_property(self):
2063
 
        return dbus.String(self.key_id)
2064
 
 
 
1270
    
2065
1271
    # Fingerprint - property
2066
 
    @dbus_annotations(
2067
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2068
1272
    @dbus_service_property(_interface, signature="s", access="read")
2069
1273
    def Fingerprint_dbus_property(self):
2070
1274
        return dbus.String(self.fingerprint)
2071
 
 
 
1275
    
2072
1276
    # Host - property
2073
 
    @dbus_service_property(_interface,
2074
 
                           signature="s",
 
1277
    @dbus_service_property(_interface, signature="s",
2075
1278
                           access="readwrite")
2076
1279
    def Host_dbus_property(self, value=None):
2077
1280
        if value is None:       # get
2078
1281
            return dbus.String(self.host)
2079
 
        self.host = str(value)
2080
 
 
 
1282
        self.host = value
 
1283
    
2081
1284
    # Created - property
2082
 
    @dbus_annotations(
2083
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2084
1285
    @dbus_service_property(_interface, signature="s", access="read")
2085
1286
    def Created_dbus_property(self):
2086
1287
        return datetime_to_dbus(self.created)
2087
 
 
 
1288
    
2088
1289
    # LastEnabled - property
2089
1290
    @dbus_service_property(_interface, signature="s", access="read")
2090
1291
    def LastEnabled_dbus_property(self):
2091
1292
        return datetime_to_dbus(self.last_enabled)
2092
 
 
 
1293
    
2093
1294
    # Enabled - property
2094
 
    @dbus_service_property(_interface,
2095
 
                           signature="b",
 
1295
    @dbus_service_property(_interface, signature="b",
2096
1296
                           access="readwrite")
2097
1297
    def Enabled_dbus_property(self, value=None):
2098
1298
        if value is None:       # get
2101
1301
            self.enable()
2102
1302
        else:
2103
1303
            self.disable()
2104
 
 
 
1304
    
2105
1305
    # LastCheckedOK - property
2106
 
    @dbus_service_property(_interface,
2107
 
                           signature="s",
 
1306
    @dbus_service_property(_interface, signature="s",
2108
1307
                           access="readwrite")
2109
1308
    def LastCheckedOK_dbus_property(self, value=None):
2110
1309
        if value is not None:
2111
1310
            self.checked_ok()
2112
1311
            return
2113
1312
        return datetime_to_dbus(self.last_checked_ok)
2114
 
 
2115
 
    # LastCheckerStatus - property
2116
 
    @dbus_service_property(_interface, signature="n", access="read")
2117
 
    def LastCheckerStatus_dbus_property(self):
2118
 
        return dbus.Int16(self.last_checker_status)
2119
 
 
 
1313
    
2120
1314
    # Expires - property
2121
1315
    @dbus_service_property(_interface, signature="s", access="read")
2122
1316
    def Expires_dbus_property(self):
2123
1317
        return datetime_to_dbus(self.expires)
2124
 
 
 
1318
    
2125
1319
    # LastApprovalRequest - property
2126
1320
    @dbus_service_property(_interface, signature="s", access="read")
2127
1321
    def LastApprovalRequest_dbus_property(self):
2128
1322
        return datetime_to_dbus(self.last_approval_request)
2129
 
 
 
1323
    
2130
1324
    # Timeout - property
2131
 
    @dbus_service_property(_interface,
2132
 
                           signature="t",
 
1325
    @dbus_service_property(_interface, signature="t",
2133
1326
                           access="readwrite")
2134
1327
    def Timeout_dbus_property(self, value=None):
2135
1328
        if value is None:       # get
2136
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
2137
 
        old_timeout = self.timeout
 
1329
            return dbus.UInt64(self.timeout_milliseconds())
2138
1330
        self.timeout = datetime.timedelta(0, 0, 0, value)
2139
 
        # Reschedule disabling
2140
 
        if self.enabled:
2141
 
            now = datetime.datetime.utcnow()
2142
 
            self.expires += self.timeout - old_timeout
2143
 
            if self.expires <= now:
2144
 
                # The timeout has passed
2145
 
                self.disable()
2146
 
            else:
2147
 
                if (getattr(self, "disable_initiator_tag", None)
2148
 
                    is None):
2149
 
                    return
2150
 
                GLib.source_remove(self.disable_initiator_tag)
2151
 
                self.disable_initiator_tag = GLib.timeout_add(
2152
 
                    int((self.expires - now).total_seconds() * 1000),
2153
 
                    self.disable)
2154
 
 
 
1331
        if getattr(self, "disable_initiator_tag", None) is None:
 
1332
            return
 
1333
        # Reschedule timeout
 
1334
        gobject.source_remove(self.disable_initiator_tag)
 
1335
        self.disable_initiator_tag = None
 
1336
        self.expires = None
 
1337
        time_to_die = _timedelta_to_milliseconds((self
 
1338
                                                  .last_checked_ok
 
1339
                                                  + self.timeout)
 
1340
                                                 - datetime.datetime
 
1341
                                                 .utcnow())
 
1342
        if time_to_die <= 0:
 
1343
            # The timeout has passed
 
1344
            self.disable()
 
1345
        else:
 
1346
            self.expires = (datetime.datetime.utcnow()
 
1347
                            + datetime.timedelta(milliseconds =
 
1348
                                                 time_to_die))
 
1349
            self.disable_initiator_tag = (gobject.timeout_add
 
1350
                                          (time_to_die, self.disable))
 
1351
    
2155
1352
    # ExtendedTimeout - property
2156
 
    @dbus_service_property(_interface,
2157
 
                           signature="t",
 
1353
    @dbus_service_property(_interface, signature="t",
2158
1354
                           access="readwrite")
2159
1355
    def ExtendedTimeout_dbus_property(self, value=None):
2160
1356
        if value is None:       # get
2161
 
            return dbus.UInt64(self.extended_timeout.total_seconds()
2162
 
                               * 1000)
 
1357
            return dbus.UInt64(self.extended_timeout_milliseconds())
2163
1358
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2164
 
 
 
1359
    
2165
1360
    # Interval - property
2166
 
    @dbus_service_property(_interface,
2167
 
                           signature="t",
 
1361
    @dbus_service_property(_interface, signature="t",
2168
1362
                           access="readwrite")
2169
1363
    def Interval_dbus_property(self, value=None):
2170
1364
        if value is None:       # get
2171
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1365
            return dbus.UInt64(self.interval_milliseconds())
2172
1366
        self.interval = datetime.timedelta(0, 0, 0, value)
2173
1367
        if getattr(self, "checker_initiator_tag", None) is None:
2174
1368
            return
2175
1369
        if self.enabled:
2176
1370
            # Reschedule checker run
2177
 
            GLib.source_remove(self.checker_initiator_tag)
2178
 
            self.checker_initiator_tag = GLib.timeout_add(
2179
 
                value, self.start_checker)
2180
 
            self.start_checker()  # Start one now, too
2181
 
 
 
1371
            gobject.source_remove(self.checker_initiator_tag)
 
1372
            self.checker_initiator_tag = (gobject.timeout_add
 
1373
                                          (value, self.start_checker))
 
1374
            self.start_checker()    # Start one now, too
 
1375
    
2182
1376
    # Checker - property
2183
 
    @dbus_service_property(_interface,
2184
 
                           signature="s",
 
1377
    @dbus_service_property(_interface, signature="s",
2185
1378
                           access="readwrite")
2186
1379
    def Checker_dbus_property(self, value=None):
2187
1380
        if value is None:       # get
2188
1381
            return dbus.String(self.checker_command)
2189
 
        self.checker_command = str(value)
2190
 
 
 
1382
        self.checker_command = value
 
1383
    
2191
1384
    # CheckerRunning - property
2192
 
    @dbus_service_property(_interface,
2193
 
                           signature="b",
 
1385
    @dbus_service_property(_interface, signature="b",
2194
1386
                           access="readwrite")
2195
1387
    def CheckerRunning_dbus_property(self, value=None):
2196
1388
        if value is None:       # get
2199
1391
            self.start_checker()
2200
1392
        else:
2201
1393
            self.stop_checker()
2202
 
 
 
1394
    
2203
1395
    # ObjectPath - property
2204
 
    @dbus_annotations(
2205
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2206
 
         "org.freedesktop.DBus.Deprecated": "true"})
2207
1396
    @dbus_service_property(_interface, signature="o", access="read")
2208
1397
    def ObjectPath_dbus_property(self):
2209
 
        return self.dbus_object_path  # is already a dbus.ObjectPath
2210
 
 
 
1398
        return self.dbus_object_path # is already a dbus.ObjectPath
 
1399
    
2211
1400
    # Secret = property
2212
 
    @dbus_annotations(
2213
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
2214
 
         "invalidates"})
2215
 
    @dbus_service_property(_interface,
2216
 
                           signature="ay",
2217
 
                           access="write",
2218
 
                           byte_arrays=True)
 
1401
    @dbus_service_property(_interface, signature="ay",
 
1402
                           access="write", byte_arrays=True)
2219
1403
    def Secret_dbus_property(self, value):
2220
 
        self.secret = bytes(value)
2221
 
 
 
1404
        self.secret = str(value)
 
1405
    
2222
1406
    del _interface
2223
1407
 
2224
1408
 
2225
 
class ProxyClient:
2226
 
    def __init__(self, child_pipe, key_id, fpr, address):
 
1409
class ProxyClient(object):
 
1410
    def __init__(self, child_pipe, fpr, address):
2227
1411
        self._pipe = child_pipe
2228
 
        self._pipe.send(('init', key_id, fpr, address))
 
1412
        self._pipe.send(('init', fpr, address))
2229
1413
        if not self._pipe.recv():
2230
 
            raise KeyError(key_id or fpr)
2231
 
 
 
1414
            raise KeyError()
 
1415
    
2232
1416
    def __getattribute__(self, name):
2233
 
        if name == '_pipe':
 
1417
        if(name == '_pipe'):
2234
1418
            return super(ProxyClient, self).__getattribute__(name)
2235
1419
        self._pipe.send(('getattr', name))
2236
1420
        data = self._pipe.recv()
2237
1421
        if data[0] == 'data':
2238
1422
            return data[1]
2239
1423
        if data[0] == 'function':
2240
 
 
2241
1424
            def func(*args, **kwargs):
2242
1425
                self._pipe.send(('funcall', name, args, kwargs))
2243
1426
                return self._pipe.recv()[1]
2244
 
 
2245
1427
            return func
2246
 
 
 
1428
    
2247
1429
    def __setattr__(self, name, value):
2248
 
        if name == '_pipe':
 
1430
        if(name == '_pipe'):
2249
1431
            return super(ProxyClient, self).__setattr__(name, value)
2250
1432
        self._pipe.send(('setattr', name, value))
2251
1433
 
2252
1434
 
 
1435
class ClientDBusTransitional(ClientDBus):
 
1436
    __metaclass__ = AlternateDBusNamesMetaclass
 
1437
 
 
1438
 
2253
1439
class ClientHandler(socketserver.BaseRequestHandler, object):
2254
1440
    """A class to handle client connections.
2255
 
 
 
1441
    
2256
1442
    Instantiated once for each connection to handle it.
2257
1443
    Note: This will run in its own forked process."""
2258
 
 
 
1444
    
2259
1445
    def handle(self):
2260
1446
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2261
1447
            logger.info("TCP connection from: %s",
2262
 
                        str(self.client_address))
 
1448
                        unicode(self.client_address))
2263
1449
            logger.debug("Pipe FD: %d",
2264
1450
                         self.server.child_pipe.fileno())
2265
 
 
2266
 
            session = gnutls.ClientSession(self.request)
2267
 
 
2268
 
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2269
 
            #                       "+AES-256-CBC", "+SHA1",
2270
 
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2271
 
            #                       "+DHE-DSS"))
 
1451
            
 
1452
            session = (gnutls.connection
 
1453
                       .ClientSession(self.request,
 
1454
                                      gnutls.connection
 
1455
                                      .X509Credentials()))
 
1456
            
 
1457
            # Note: gnutls.connection.X509Credentials is really a
 
1458
            # generic GnuTLS certificate credentials object so long as
 
1459
            # no X.509 keys are added to it.  Therefore, we can use it
 
1460
            # here despite using OpenPGP certificates.
 
1461
            
 
1462
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
1463
            #                      "+AES-256-CBC", "+SHA1",
 
1464
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
1465
            #                      "+DHE-DSS"))
2272
1466
            # Use a fallback default, since this MUST be set.
2273
1467
            priority = self.server.gnutls_priority
2274
1468
            if priority is None:
2275
1469
                priority = "NORMAL"
2276
 
            gnutls.priority_set_direct(session._c_object,
2277
 
                                       priority.encode("utf-8"),
2278
 
                                       None)
2279
 
 
 
1470
            (gnutls.library.functions
 
1471
             .gnutls_priority_set_direct(session._c_object,
 
1472
                                         priority, None))
 
1473
            
2280
1474
            # Start communication using the Mandos protocol
2281
1475
            # Get protocol number
2282
1476
            line = self.request.makefile().readline()
2283
1477
            logger.debug("Protocol version: %r", line)
2284
1478
            try:
2285
1479
                if int(line.strip().split()[0]) > 1:
2286
 
                    raise RuntimeError(line)
 
1480
                    raise RuntimeError
2287
1481
            except (ValueError, IndexError, RuntimeError) as error:
2288
1482
                logger.error("Unknown protocol version: %s", error)
2289
1483
                return
2290
 
 
 
1484
            
2291
1485
            # Start GnuTLS connection
2292
1486
            try:
2293
1487
                session.handshake()
2294
 
            except gnutls.Error as error:
 
1488
            except gnutls.errors.GNUTLSError as error:
2295
1489
                logger.warning("Handshake failed: %s", error)
2296
1490
                # Do not run session.bye() here: the session is not
2297
1491
                # established.  Just abandon the request.
2298
1492
                return
2299
1493
            logger.debug("Handshake succeeded")
2300
 
 
 
1494
            
2301
1495
            approval_required = False
2302
1496
            try:
2303
 
                if gnutls.has_rawpk:
2304
 
                    fpr = b""
2305
 
                    try:
2306
 
                        key_id = self.key_id(
2307
 
                            self.peer_certificate(session))
2308
 
                    except (TypeError, gnutls.Error) as error:
2309
 
                        logger.warning("Bad certificate: %s", error)
2310
 
                        return
2311
 
                    logger.debug("Key ID: %s", key_id)
2312
 
 
2313
 
                else:
2314
 
                    key_id = b""
2315
 
                    try:
2316
 
                        fpr = self.fingerprint(
2317
 
                            self.peer_certificate(session))
2318
 
                    except (TypeError, gnutls.Error) as error:
2319
 
                        logger.warning("Bad certificate: %s", error)
2320
 
                        return
2321
 
                    logger.debug("Fingerprint: %s", fpr)
2322
 
 
2323
 
                try:
2324
 
                    client = ProxyClient(child_pipe, key_id, fpr,
 
1497
                try:
 
1498
                    fpr = self.fingerprint(self.peer_certificate
 
1499
                                           (session))
 
1500
                except (TypeError,
 
1501
                        gnutls.errors.GNUTLSError) as error:
 
1502
                    logger.warning("Bad certificate: %s", error)
 
1503
                    return
 
1504
                logger.debug("Fingerprint: %s", fpr)
 
1505
                if self.server.use_dbus:
 
1506
                    # Emit D-Bus signal
 
1507
                    client.NewRequest(str(self.client_address))
 
1508
                
 
1509
                try:
 
1510
                    client = ProxyClient(child_pipe, fpr,
2325
1511
                                         self.client_address)
2326
1512
                except KeyError:
2327
1513
                    return
2328
 
 
 
1514
                
2329
1515
                if client.approval_delay:
2330
1516
                    delay = client.approval_delay
2331
1517
                    client.approvals_pending += 1
2332
1518
                    approval_required = True
2333
 
 
 
1519
                
2334
1520
                while True:
2335
1521
                    if not client.enabled:
2336
1522
                        logger.info("Client %s is disabled",
2337
 
                                    client.name)
 
1523
                                       client.name)
2338
1524
                        if self.server.use_dbus:
2339
1525
                            # Emit D-Bus signal
2340
1526
                            client.Rejected("Disabled")
2341
1527
                        return
2342
 
 
2343
 
                    if client.approved or not client.approval_delay:
2344
 
                        # We are approved or approval is disabled
 
1528
                    
 
1529
                    if client._approved or not client.approval_delay:
 
1530
                        #We are approved or approval is disabled
2345
1531
                        break
2346
 
                    elif client.approved is None:
 
1532
                    elif client._approved is None:
2347
1533
                        logger.info("Client %s needs approval",
2348
1534
                                    client.name)
2349
1535
                        if self.server.use_dbus:
2350
1536
                            # Emit D-Bus signal
2351
1537
                            client.NeedApproval(
2352
 
                                client.approval_delay.total_seconds()
2353
 
                                * 1000, client.approved_by_default)
 
1538
                                client.approval_delay_milliseconds(),
 
1539
                                client.approved_by_default)
2354
1540
                    else:
2355
1541
                        logger.warning("Client %s was not approved",
2356
1542
                                       client.name)
2358
1544
                            # Emit D-Bus signal
2359
1545
                            client.Rejected("Denied")
2360
1546
                        return
2361
 
 
2362
 
                    # wait until timeout or approved
 
1547
                    
 
1548
                    #wait until timeout or approved
2363
1549
                    time = datetime.datetime.now()
2364
1550
                    client.changedstate.acquire()
2365
 
                    client.changedstate.wait(delay.total_seconds())
 
1551
                    (client.changedstate.wait
 
1552
                     (float(client._timedelta_to_milliseconds(delay)
 
1553
                            / 1000)))
2366
1554
                    client.changedstate.release()
2367
1555
                    time2 = datetime.datetime.now()
2368
1556
                    if (time2 - time) >= delay:
2378
1566
                            break
2379
1567
                    else:
2380
1568
                        delay -= time2 - time
2381
 
 
2382
 
                try:
2383
 
                    session.send(client.secret)
2384
 
                except gnutls.Error as error:
2385
 
                    logger.warning("gnutls send failed",
2386
 
                                   exc_info=error)
2387
 
                    return
2388
 
 
 
1569
                
 
1570
                sent_size = 0
 
1571
                while sent_size < len(client.secret):
 
1572
                    try:
 
1573
                        sent = session.send(client.secret[sent_size:])
 
1574
                    except gnutls.errors.GNUTLSError as error:
 
1575
                        logger.warning("gnutls send failed")
 
1576
                        return
 
1577
                    logger.debug("Sent: %d, remaining: %d",
 
1578
                                 sent, len(client.secret)
 
1579
                                 - (sent_size + sent))
 
1580
                    sent_size += sent
 
1581
                
2389
1582
                logger.info("Sending secret to %s", client.name)
2390
1583
                # bump the timeout using extended_timeout
2391
 
                client.bump_timeout(client.extended_timeout)
 
1584
                client.checked_ok(client.extended_timeout)
2392
1585
                if self.server.use_dbus:
2393
1586
                    # Emit D-Bus signal
2394
1587
                    client.GotSecret()
2395
 
 
 
1588
            
2396
1589
            finally:
2397
1590
                if approval_required:
2398
1591
                    client.approvals_pending -= 1
2399
1592
                try:
2400
1593
                    session.bye()
2401
 
                except gnutls.Error as error:
2402
 
                    logger.warning("GnuTLS bye failed",
2403
 
                                   exc_info=error)
2404
 
 
 
1594
                except gnutls.errors.GNUTLSError as error:
 
1595
                    logger.warning("GnuTLS bye failed")
 
1596
    
2405
1597
    @staticmethod
2406
1598
    def peer_certificate(session):
2407
 
        "Return the peer's certificate as a bytestring"
2408
 
        try:
2409
 
            cert_type = gnutls.certificate_type_get2(session._c_object,
2410
 
                                                     gnutls.CTYPE_PEERS)
2411
 
        except AttributeError:
2412
 
            cert_type = gnutls.certificate_type_get(session._c_object)
2413
 
        if gnutls.has_rawpk:
2414
 
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2415
 
        else:
2416
 
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2417
 
        # If not a valid certificate type...
2418
 
        if cert_type not in valid_cert_types:
2419
 
            logger.info("Cert type %r not in %r", cert_type,
2420
 
                        valid_cert_types)
2421
 
            # ...return invalid data
2422
 
            return b""
 
1599
        "Return the peer's OpenPGP certificate as a bytestring"
 
1600
        # If not an OpenPGP certificate...
 
1601
        if (gnutls.library.functions
 
1602
            .gnutls_certificate_type_get(session._c_object)
 
1603
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
1604
            # ...do the normal thing
 
1605
            return session.peer_certificate
2423
1606
        list_size = ctypes.c_uint(1)
2424
 
        cert_list = (gnutls.certificate_get_peers
 
1607
        cert_list = (gnutls.library.functions
 
1608
                     .gnutls_certificate_get_peers
2425
1609
                     (session._c_object, ctypes.byref(list_size)))
2426
1610
        if not bool(cert_list) and list_size.value != 0:
2427
 
            raise gnutls.Error("error getting peer certificate")
 
1611
            raise gnutls.errors.GNUTLSError("error getting peer"
 
1612
                                            " certificate")
2428
1613
        if list_size.value == 0:
2429
1614
            return None
2430
1615
        cert = cert_list[0]
2431
1616
        return ctypes.string_at(cert.data, cert.size)
2432
 
 
2433
 
    @staticmethod
2434
 
    def key_id(certificate):
2435
 
        "Convert a certificate bytestring to a hexdigit key ID"
2436
 
        # New GnuTLS "datum" with the public key
2437
 
        datum = gnutls.datum_t(
2438
 
            ctypes.cast(ctypes.c_char_p(certificate),
2439
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2440
 
            ctypes.c_uint(len(certificate)))
2441
 
        # XXX all these need to be created in the gnutls "module"
2442
 
        # New empty GnuTLS certificate
2443
 
        pubkey = gnutls.pubkey_t()
2444
 
        gnutls.pubkey_init(ctypes.byref(pubkey))
2445
 
        # Import the raw public key into the certificate
2446
 
        gnutls.pubkey_import(pubkey,
2447
 
                             ctypes.byref(datum),
2448
 
                             gnutls.X509_FMT_DER)
2449
 
        # New buffer for the key ID
2450
 
        buf = ctypes.create_string_buffer(32)
2451
 
        buf_len = ctypes.c_size_t(len(buf))
2452
 
        # Get the key ID from the raw public key into the buffer
2453
 
        gnutls.pubkey_get_key_id(pubkey,
2454
 
                                 gnutls.KEYID_USE_SHA256,
2455
 
                                 ctypes.cast(ctypes.byref(buf),
2456
 
                                             ctypes.POINTER(ctypes.c_ubyte)),
2457
 
                                 ctypes.byref(buf_len))
2458
 
        # Deinit the certificate
2459
 
        gnutls.pubkey_deinit(pubkey)
2460
 
 
2461
 
        # Convert the buffer to a Python bytestring
2462
 
        key_id = ctypes.string_at(buf, buf_len.value)
2463
 
        # Convert the bytestring to hexadecimal notation
2464
 
        hex_key_id = binascii.hexlify(key_id).upper()
2465
 
        return hex_key_id
2466
 
 
 
1617
    
2467
1618
    @staticmethod
2468
1619
    def fingerprint(openpgp):
2469
1620
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2470
1621
        # New GnuTLS "datum" with the OpenPGP public key
2471
 
        datum = gnutls.datum_t(
2472
 
            ctypes.cast(ctypes.c_char_p(openpgp),
2473
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2474
 
            ctypes.c_uint(len(openpgp)))
 
1622
        datum = (gnutls.library.types
 
1623
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1624
                                             ctypes.POINTER
 
1625
                                             (ctypes.c_ubyte)),
 
1626
                                 ctypes.c_uint(len(openpgp))))
2475
1627
        # New empty GnuTLS certificate
2476
 
        crt = gnutls.openpgp_crt_t()
2477
 
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
1628
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
1629
        (gnutls.library.functions
 
1630
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
2478
1631
        # Import the OpenPGP public key into the certificate
2479
 
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2480
 
                                  gnutls.OPENPGP_FMT_RAW)
 
1632
        (gnutls.library.functions
 
1633
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1634
                                    gnutls.library.constants
 
1635
                                    .GNUTLS_OPENPGP_FMT_RAW))
2481
1636
        # Verify the self signature in the key
2482
1637
        crtverify = ctypes.c_uint()
2483
 
        gnutls.openpgp_crt_verify_self(crt, 0,
2484
 
                                       ctypes.byref(crtverify))
 
1638
        (gnutls.library.functions
 
1639
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1640
                                         ctypes.byref(crtverify)))
2485
1641
        if crtverify.value != 0:
2486
 
            gnutls.openpgp_crt_deinit(crt)
2487
 
            raise gnutls.CertificateSecurityError(code
2488
 
                                                  =crtverify.value)
 
1642
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1643
            raise (gnutls.errors.CertificateSecurityError
 
1644
                   ("Verify failed"))
2489
1645
        # New buffer for the fingerprint
2490
1646
        buf = ctypes.create_string_buffer(20)
2491
1647
        buf_len = ctypes.c_size_t()
2492
1648
        # Get the fingerprint from the certificate into the buffer
2493
 
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2494
 
                                           ctypes.byref(buf_len))
 
1649
        (gnutls.library.functions
 
1650
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1651
                                             ctypes.byref(buf_len)))
2495
1652
        # Deinit the certificate
2496
 
        gnutls.openpgp_crt_deinit(crt)
 
1653
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2497
1654
        # Convert the buffer to a Python bytestring
2498
1655
        fpr = ctypes.string_at(buf, buf_len.value)
2499
1656
        # Convert the bytestring to hexadecimal notation
2501
1658
        return hex_fpr
2502
1659
 
2503
1660
 
2504
 
class MultiprocessingMixIn:
 
1661
class MultiprocessingMixIn(object):
2505
1662
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2506
 
 
2507
1663
    def sub_process_main(self, request, address):
2508
1664
        try:
2509
1665
            self.finish_request(request, address)
2510
 
        except Exception:
 
1666
        except:
2511
1667
            self.handle_error(request, address)
2512
1668
        self.close_request(request)
2513
 
 
 
1669
    
2514
1670
    def process_request(self, request, address):
2515
1671
        """Start a new process to process the request."""
2516
 
        proc = multiprocessing.Process(target=self.sub_process_main,
2517
 
                                       args=(request, address))
 
1672
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1673
                                       args = (request,
 
1674
                                               address))
2518
1675
        proc.start()
2519
1676
        return proc
2520
1677
 
2521
1678
 
2522
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
1679
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2523
1680
    """ adds a pipe to the MixIn """
2524
 
 
2525
1681
    def process_request(self, request, client_address):
2526
1682
        """Overrides and wraps the original process_request().
2527
 
 
 
1683
        
2528
1684
        This function creates a new pipe in self.pipe
2529
1685
        """
2530
1686
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
2531
 
 
 
1687
        
2532
1688
        proc = MultiprocessingMixIn.process_request(self, request,
2533
1689
                                                    client_address)
2534
1690
        self.child_pipe.close()
2535
1691
        self.add_pipe(parent_pipe, proc)
2536
 
 
 
1692
    
2537
1693
    def add_pipe(self, parent_pipe, proc):
2538
1694
        """Dummy function; override as necessary"""
2539
 
        raise NotImplementedError()
 
1695
        raise NotImplementedError
2540
1696
 
2541
1697
 
2542
1698
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2543
 
                     socketserver.TCPServer):
 
1699
                     socketserver.TCPServer, object):
2544
1700
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2545
 
 
 
1701
    
2546
1702
    Attributes:
2547
1703
        enabled:        Boolean; whether this server is activated yet
2548
1704
        interface:      None or a network interface name (string)
2549
1705
        use_ipv6:       Boolean; to use IPv6 or not
2550
1706
    """
2551
 
 
2552
1707
    def __init__(self, server_address, RequestHandlerClass,
2553
 
                 interface=None,
2554
 
                 use_ipv6=True,
2555
 
                 socketfd=None):
2556
 
        """If socketfd is set, use that file descriptor instead of
2557
 
        creating a new one with socket.socket().
2558
 
        """
 
1708
                 interface=None, use_ipv6=True):
2559
1709
        self.interface = interface
2560
1710
        if use_ipv6:
2561
1711
            self.address_family = socket.AF_INET6
2562
 
        if socketfd is not None:
2563
 
            # Save the file descriptor
2564
 
            self.socketfd = socketfd
2565
 
            # Save the original socket.socket() function
2566
 
            self.socket_socket = socket.socket
2567
 
 
2568
 
            # To implement --socket, we monkey patch socket.socket.
2569
 
            #
2570
 
            # (When socketserver.TCPServer is a new-style class, we
2571
 
            # could make self.socket into a property instead of monkey
2572
 
            # patching socket.socket.)
2573
 
            #
2574
 
            # Create a one-time-only replacement for socket.socket()
2575
 
            @functools.wraps(socket.socket)
2576
 
            def socket_wrapper(*args, **kwargs):
2577
 
                # Restore original function so subsequent calls are
2578
 
                # not affected.
2579
 
                socket.socket = self.socket_socket
2580
 
                del self.socket_socket
2581
 
                # This time only, return a new socket object from the
2582
 
                # saved file descriptor.
2583
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
2584
 
            # Replace socket.socket() function with wrapper
2585
 
            socket.socket = socket_wrapper
2586
 
        # The socketserver.TCPServer.__init__ will call
2587
 
        # socket.socket(), which might be our replacement,
2588
 
        # socket_wrapper(), if socketfd was set.
2589
1712
        socketserver.TCPServer.__init__(self, server_address,
2590
1713
                                        RequestHandlerClass)
2591
 
 
2592
1714
    def server_bind(self):
2593
1715
        """This overrides the normal server_bind() function
2594
1716
        to bind to an interface if one was specified, and also NOT to
2595
1717
        bind to an address or port if they were not specified."""
2596
 
        global SO_BINDTODEVICE
2597
1718
        if self.interface is not None:
2598
1719
            if SO_BINDTODEVICE is None:
2599
 
                # Fall back to a hard-coded value which seems to be
2600
 
                # common enough.
2601
 
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2602
 
                SO_BINDTODEVICE = 25
2603
 
            try:
2604
 
                self.socket.setsockopt(
2605
 
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
2606
 
                    (self.interface + "\0").encode("utf-8"))
2607
 
            except socket.error as error:
2608
 
                if error.errno == errno.EPERM:
2609
 
                    logger.error("No permission to bind to"
2610
 
                                 " interface %s", self.interface)
2611
 
                elif error.errno == errno.ENOPROTOOPT:
2612
 
                    logger.error("SO_BINDTODEVICE not available;"
2613
 
                                 " cannot bind to interface %s",
2614
 
                                 self.interface)
2615
 
                elif error.errno == errno.ENODEV:
2616
 
                    logger.error("Interface %s does not exist,"
2617
 
                                 " cannot bind", self.interface)
2618
 
                else:
2619
 
                    raise
 
1720
                logger.error("SO_BINDTODEVICE does not exist;"
 
1721
                             " cannot bind to interface %s",
 
1722
                             self.interface)
 
1723
            else:
 
1724
                try:
 
1725
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1726
                                           SO_BINDTODEVICE,
 
1727
                                           str(self.interface
 
1728
                                               + '\0'))
 
1729
                except socket.error as error:
 
1730
                    if error[0] == errno.EPERM:
 
1731
                        logger.error("No permission to"
 
1732
                                     " bind to interface %s",
 
1733
                                     self.interface)
 
1734
                    elif error[0] == errno.ENOPROTOOPT:
 
1735
                        logger.error("SO_BINDTODEVICE not available;"
 
1736
                                     " cannot bind to interface %s",
 
1737
                                     self.interface)
 
1738
                    else:
 
1739
                        raise
2620
1740
        # Only bind(2) the socket if we really need to.
2621
1741
        if self.server_address[0] or self.server_address[1]:
2622
 
            if self.server_address[1]:
2623
 
                self.allow_reuse_address = True
2624
1742
            if not self.server_address[0]:
2625
1743
                if self.address_family == socket.AF_INET6:
2626
 
                    any_address = "::"  # in6addr_any
 
1744
                    any_address = "::" # in6addr_any
2627
1745
                else:
2628
 
                    any_address = "0.0.0.0"  # INADDR_ANY
 
1746
                    any_address = socket.INADDR_ANY
2629
1747
                self.server_address = (any_address,
2630
1748
                                       self.server_address[1])
2631
1749
            elif not self.server_address[1]:
2632
 
                self.server_address = (self.server_address[0], 0)
 
1750
                self.server_address = (self.server_address[0],
 
1751
                                       0)
2633
1752
#                 if self.interface:
2634
1753
#                     self.server_address = (self.server_address[0],
2635
1754
#                                            0, # port
2641
1760
 
2642
1761
class MandosServer(IPv6_TCPServer):
2643
1762
    """Mandos server.
2644
 
 
 
1763
    
2645
1764
    Attributes:
2646
1765
        clients:        set of Client objects
2647
1766
        gnutls_priority GnuTLS priority string
2648
1767
        use_dbus:       Boolean; to emit D-Bus signals or not
2649
 
 
2650
 
    Assumes a GLib.MainLoop event loop.
 
1768
    
 
1769
    Assumes a gobject.MainLoop event loop.
2651
1770
    """
2652
 
 
2653
1771
    def __init__(self, server_address, RequestHandlerClass,
2654
 
                 interface=None,
2655
 
                 use_ipv6=True,
2656
 
                 clients=None,
2657
 
                 gnutls_priority=None,
2658
 
                 use_dbus=True,
2659
 
                 socketfd=None):
 
1772
                 interface=None, use_ipv6=True, clients=None,
 
1773
                 gnutls_priority=None, use_dbus=True):
2660
1774
        self.enabled = False
2661
1775
        self.clients = clients
2662
1776
        if self.clients is None:
2665
1779
        self.gnutls_priority = gnutls_priority
2666
1780
        IPv6_TCPServer.__init__(self, server_address,
2667
1781
                                RequestHandlerClass,
2668
 
                                interface=interface,
2669
 
                                use_ipv6=use_ipv6,
2670
 
                                socketfd=socketfd)
2671
 
 
 
1782
                                interface = interface,
 
1783
                                use_ipv6 = use_ipv6)
2672
1784
    def server_activate(self):
2673
1785
        if self.enabled:
2674
1786
            return socketserver.TCPServer.server_activate(self)
2675
 
 
 
1787
    
2676
1788
    def enable(self):
2677
1789
        self.enabled = True
2678
 
 
 
1790
    
2679
1791
    def add_pipe(self, parent_pipe, proc):
2680
1792
        # Call "handle_ipc" for both data and EOF events
2681
 
        GLib.io_add_watch(
2682
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2683
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2684
 
            functools.partial(self.handle_ipc,
2685
 
                              parent_pipe=parent_pipe,
2686
 
                              proc=proc))
2687
 
 
2688
 
    def handle_ipc(self, source, condition,
2689
 
                   parent_pipe=None,
2690
 
                   proc=None,
2691
 
                   client_object=None):
 
1793
        gobject.io_add_watch(parent_pipe.fileno(),
 
1794
                             gobject.IO_IN | gobject.IO_HUP,
 
1795
                             functools.partial(self.handle_ipc,
 
1796
                                               parent_pipe =
 
1797
                                               parent_pipe,
 
1798
                                               proc = proc))
 
1799
    
 
1800
    def handle_ipc(self, source, condition, parent_pipe=None,
 
1801
                   proc = None, client_object=None):
 
1802
        condition_names = {
 
1803
            gobject.IO_IN: "IN",   # There is data to read.
 
1804
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1805
                                    # blocking).
 
1806
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1807
            gobject.IO_ERR: "ERR", # Error condition.
 
1808
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1809
                                    # broken, usually for pipes and
 
1810
                                    # sockets).
 
1811
            }
 
1812
        conditions_string = ' | '.join(name
 
1813
                                       for cond, name in
 
1814
                                       condition_names.iteritems()
 
1815
                                       if cond & condition)
2692
1816
        # error, or the other end of multiprocessing.Pipe has closed
2693
 
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
 
1817
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2694
1818
            # Wait for other process to exit
2695
1819
            proc.join()
2696
1820
            return False
2697
 
 
 
1821
        
2698
1822
        # Read a request from the child
2699
1823
        request = parent_pipe.recv()
2700
1824
        command = request[0]
2701
 
 
 
1825
        
2702
1826
        if command == 'init':
2703
 
            key_id = request[1].decode("ascii")
2704
 
            fpr = request[2].decode("ascii")
2705
 
            address = request[3]
2706
 
 
2707
 
            for c in self.clients.values():
2708
 
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2709
 
                    continue
2710
 
                if key_id and c.key_id == key_id:
2711
 
                    client = c
2712
 
                    break
2713
 
                if fpr and c.fingerprint == fpr:
 
1827
            fpr = request[1]
 
1828
            address = request[2]
 
1829
            
 
1830
            for c in self.clients.itervalues():
 
1831
                if c.fingerprint == fpr:
2714
1832
                    client = c
2715
1833
                    break
2716
1834
            else:
2717
 
                logger.info("Client not found for key ID: %s, address"
2718
 
                            ": %s", key_id or fpr, address)
 
1835
                logger.info("Client not found for fingerprint: %s, ad"
 
1836
                            "dress: %s", fpr, address)
2719
1837
                if self.use_dbus:
2720
1838
                    # Emit D-Bus signal
2721
 
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
 
1839
                    mandos_dbus_service.ClientNotFound(fpr,
2722
1840
                                                       address[0])
2723
1841
                parent_pipe.send(False)
2724
1842
                return False
2725
 
 
2726
 
            GLib.io_add_watch(
2727
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2728
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2729
 
                functools.partial(self.handle_ipc,
2730
 
                                  parent_pipe=parent_pipe,
2731
 
                                  proc=proc,
2732
 
                                  client_object=client))
 
1843
            
 
1844
            gobject.io_add_watch(parent_pipe.fileno(),
 
1845
                                 gobject.IO_IN | gobject.IO_HUP,
 
1846
                                 functools.partial(self.handle_ipc,
 
1847
                                                   parent_pipe =
 
1848
                                                   parent_pipe,
 
1849
                                                   proc = proc,
 
1850
                                                   client_object =
 
1851
                                                   client))
2733
1852
            parent_pipe.send(True)
2734
1853
            # remove the old hook in favor of the new above hook on
2735
1854
            # same fileno
2738
1857
            funcname = request[1]
2739
1858
            args = request[2]
2740
1859
            kwargs = request[3]
2741
 
 
 
1860
            
2742
1861
            parent_pipe.send(('data', getattr(client_object,
2743
1862
                                              funcname)(*args,
2744
 
                                                        **kwargs)))
2745
 
 
 
1863
                                                         **kwargs)))
 
1864
        
2746
1865
        if command == 'getattr':
2747
1866
            attrname = request[1]
2748
 
            if isinstance(client_object.__getattribute__(attrname),
2749
 
                          collections.Callable):
2750
 
                parent_pipe.send(('function', ))
 
1867
            if callable(client_object.__getattribute__(attrname)):
 
1868
                parent_pipe.send(('function',))
2751
1869
            else:
2752
 
                parent_pipe.send((
2753
 
                    'data', client_object.__getattribute__(attrname)))
2754
 
 
 
1870
                parent_pipe.send(('data', client_object
 
1871
                                  .__getattribute__(attrname)))
 
1872
        
2755
1873
        if command == 'setattr':
2756
1874
            attrname = request[1]
2757
1875
            value = request[2]
2758
1876
            setattr(client_object, attrname, value)
2759
 
 
 
1877
        
2760
1878
        return True
2761
1879
 
2762
1880
 
2763
 
def rfc3339_duration_to_delta(duration):
2764
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2765
 
 
2766
 
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2767
 
    True
2768
 
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2769
 
    True
2770
 
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2771
 
    True
2772
 
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2773
 
    True
2774
 
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2775
 
    True
2776
 
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2777
 
    True
2778
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2779
 
    True
2780
 
    """
2781
 
 
2782
 
    # Parsing an RFC 3339 duration with regular expressions is not
2783
 
    # possible - there would have to be multiple places for the same
2784
 
    # values, like seconds.  The current code, while more esoteric, is
2785
 
    # cleaner without depending on a parsing library.  If Python had a
2786
 
    # built-in library for parsing we would use it, but we'd like to
2787
 
    # avoid excessive use of external libraries.
2788
 
 
2789
 
    # New type for defining tokens, syntax, and semantics all-in-one
2790
 
    Token = collections.namedtuple("Token", (
2791
 
        "regexp",  # To match token; if "value" is not None, must have
2792
 
                   # a "group" containing digits
2793
 
        "value",   # datetime.timedelta or None
2794
 
        "followers"))           # Tokens valid after this token
2795
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2796
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2797
 
    token_end = Token(re.compile(r"$"), None, frozenset())
2798
 
    token_second = Token(re.compile(r"(\d+)S"),
2799
 
                         datetime.timedelta(seconds=1),
2800
 
                         frozenset((token_end, )))
2801
 
    token_minute = Token(re.compile(r"(\d+)M"),
2802
 
                         datetime.timedelta(minutes=1),
2803
 
                         frozenset((token_second, token_end)))
2804
 
    token_hour = Token(re.compile(r"(\d+)H"),
2805
 
                       datetime.timedelta(hours=1),
2806
 
                       frozenset((token_minute, token_end)))
2807
 
    token_time = Token(re.compile(r"T"),
2808
 
                       None,
2809
 
                       frozenset((token_hour, token_minute,
2810
 
                                  token_second)))
2811
 
    token_day = Token(re.compile(r"(\d+)D"),
2812
 
                      datetime.timedelta(days=1),
2813
 
                      frozenset((token_time, token_end)))
2814
 
    token_month = Token(re.compile(r"(\d+)M"),
2815
 
                        datetime.timedelta(weeks=4),
2816
 
                        frozenset((token_day, token_end)))
2817
 
    token_year = Token(re.compile(r"(\d+)Y"),
2818
 
                       datetime.timedelta(weeks=52),
2819
 
                       frozenset((token_month, token_end)))
2820
 
    token_week = Token(re.compile(r"(\d+)W"),
2821
 
                       datetime.timedelta(weeks=1),
2822
 
                       frozenset((token_end, )))
2823
 
    token_duration = Token(re.compile(r"P"), None,
2824
 
                           frozenset((token_year, token_month,
2825
 
                                      token_day, token_time,
2826
 
                                      token_week)))
2827
 
    # Define starting values:
2828
 
    # Value so far
2829
 
    value = datetime.timedelta()
2830
 
    found_token = None
2831
 
    # Following valid tokens
2832
 
    followers = frozenset((token_duration, ))
2833
 
    # String left to parse
2834
 
    s = duration
2835
 
    # Loop until end token is found
2836
 
    while found_token is not token_end:
2837
 
        # Search for any currently valid tokens
2838
 
        for token in followers:
2839
 
            match = token.regexp.match(s)
2840
 
            if match is not None:
2841
 
                # Token found
2842
 
                if token.value is not None:
2843
 
                    # Value found, parse digits
2844
 
                    factor = int(match.group(1), 10)
2845
 
                    # Add to value so far
2846
 
                    value += factor * token.value
2847
 
                # Strip token from string
2848
 
                s = token.regexp.sub("", s, 1)
2849
 
                # Go to found token
2850
 
                found_token = token
2851
 
                # Set valid next tokens
2852
 
                followers = found_token.followers
2853
 
                break
2854
 
        else:
2855
 
            # No currently valid tokens were found
2856
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
2857
 
                             .format(duration))
2858
 
    # End token found
2859
 
    return value
2860
 
 
2861
 
 
2862
1881
def string_to_delta(interval):
2863
1882
    """Parse a string and return a datetime.timedelta
2864
 
 
2865
 
    >>> string_to_delta('7d') == datetime.timedelta(7)
2866
 
    True
2867
 
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
2868
 
    True
2869
 
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2870
 
    True
2871
 
    >>> string_to_delta('24h') == datetime.timedelta(1)
2872
 
    True
2873
 
    >>> string_to_delta('1w') == datetime.timedelta(7)
2874
 
    True
2875
 
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2876
 
    True
 
1883
    
 
1884
    >>> string_to_delta('7d')
 
1885
    datetime.timedelta(7)
 
1886
    >>> string_to_delta('60s')
 
1887
    datetime.timedelta(0, 60)
 
1888
    >>> string_to_delta('60m')
 
1889
    datetime.timedelta(0, 3600)
 
1890
    >>> string_to_delta('24h')
 
1891
    datetime.timedelta(1)
 
1892
    >>> string_to_delta('1w')
 
1893
    datetime.timedelta(7)
 
1894
    >>> string_to_delta('5m 30s')
 
1895
    datetime.timedelta(0, 330)
2877
1896
    """
2878
 
 
2879
 
    try:
2880
 
        return rfc3339_duration_to_delta(interval)
2881
 
    except ValueError:
2882
 
        pass
2883
 
 
2884
1897
    timevalue = datetime.timedelta(0)
2885
1898
    for s in interval.split():
2886
1899
        try:
2887
 
            suffix = s[-1]
 
1900
            suffix = unicode(s[-1])
2888
1901
            value = int(s[:-1])
2889
1902
            if suffix == "d":
2890
1903
                delta = datetime.timedelta(value)
2897
1910
            elif suffix == "w":
2898
1911
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2899
1912
            else:
2900
 
                raise ValueError("Unknown suffix {!r}".format(suffix))
2901
 
        except IndexError as e:
 
1913
                raise ValueError("Unknown suffix %r" % suffix)
 
1914
        except (ValueError, IndexError) as e:
2902
1915
            raise ValueError(*(e.args))
2903
1916
        timevalue += delta
2904
1917
    return timevalue
2905
1918
 
2906
1919
 
2907
 
def daemon(nochdir=False, noclose=False):
 
1920
def daemon(nochdir = False, noclose = False):
2908
1921
    """See daemon(3).  Standard BSD Unix function.
2909
 
 
 
1922
    
2910
1923
    This should really exist as os.daemon, but it doesn't (yet)."""
2911
1924
    if os.fork():
2912
1925
        sys.exit()
2917
1930
        sys.exit()
2918
1931
    if not noclose:
2919
1932
        # Close all standard open file descriptors
2920
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1933
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2921
1934
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2922
1935
            raise OSError(errno.ENODEV,
2923
 
                          "{} not a character device"
2924
 
                          .format(os.devnull))
 
1936
                          "%s not a character device"
 
1937
                          % os.path.devnull)
2925
1938
        os.dup2(null, sys.stdin.fileno())
2926
1939
        os.dup2(null, sys.stdout.fileno())
2927
1940
        os.dup2(null, sys.stderr.fileno())
2930
1943
 
2931
1944
 
2932
1945
def main():
2933
 
 
 
1946
    
2934
1947
    ##################################################################
2935
1948
    # Parsing of options, both command line and config file
2936
 
 
 
1949
    
2937
1950
    parser = argparse.ArgumentParser()
2938
1951
    parser.add_argument("-v", "--version", action="version",
2939
 
                        version="%(prog)s {}".format(version),
 
1952
                        version = "%%(prog)s %s" % version,
2940
1953
                        help="show version number and exit")
2941
1954
    parser.add_argument("-i", "--interface", metavar="IF",
2942
1955
                        help="Bind to interface IF")
2948
1961
                        help="Run self-test")
2949
1962
    parser.add_argument("--debug", action="store_true",
2950
1963
                        help="Debug mode; run in foreground and log"
2951
 
                        " to terminal", default=None)
 
1964
                        " to terminal")
2952
1965
    parser.add_argument("--debuglevel", metavar="LEVEL",
2953
1966
                        help="Debug level for stdout output")
2954
1967
    parser.add_argument("--priority", help="GnuTLS"
2961
1974
                        " files")
2962
1975
    parser.add_argument("--no-dbus", action="store_false",
2963
1976
                        dest="use_dbus", help="Do not provide D-Bus"
2964
 
                        " system bus interface", default=None)
 
1977
                        " system bus interface")
2965
1978
    parser.add_argument("--no-ipv6", action="store_false",
2966
 
                        dest="use_ipv6", help="Do not use IPv6",
2967
 
                        default=None)
 
1979
                        dest="use_ipv6", help="Do not use IPv6")
2968
1980
    parser.add_argument("--no-restore", action="store_false",
2969
1981
                        dest="restore", help="Do not restore stored"
2970
 
                        " state", default=None)
2971
 
    parser.add_argument("--socket", type=int,
2972
 
                        help="Specify a file descriptor to a network"
2973
 
                        " socket to use instead of creating one")
 
1982
                        " state")
2974
1983
    parser.add_argument("--statedir", metavar="DIR",
2975
1984
                        help="Directory to save/restore state in")
2976
 
    parser.add_argument("--foreground", action="store_true",
2977
 
                        help="Run in foreground", default=None)
2978
 
    parser.add_argument("--no-zeroconf", action="store_false",
2979
 
                        dest="zeroconf", help="Do not use Zeroconf",
2980
 
                        default=None)
2981
 
 
 
1985
    
2982
1986
    options = parser.parse_args()
2983
 
 
 
1987
    
 
1988
    if options.check:
 
1989
        import doctest
 
1990
        doctest.testmod()
 
1991
        sys.exit()
 
1992
    
2984
1993
    # Default values for config file for server-global settings
2985
 
    if gnutls.has_rawpk:
2986
 
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2987
 
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2988
 
    else:
2989
 
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2990
 
                    ":+SIGN-DSA-SHA256")
2991
 
    server_defaults = {"interface": "",
2992
 
                       "address": "",
2993
 
                       "port": "",
2994
 
                       "debug": "False",
2995
 
                       "priority": priority,
2996
 
                       "servicename": "Mandos",
2997
 
                       "use_dbus": "True",
2998
 
                       "use_ipv6": "True",
2999
 
                       "debuglevel": "",
3000
 
                       "restore": "True",
3001
 
                       "socket": "",
3002
 
                       "statedir": "/var/lib/mandos",
3003
 
                       "foreground": "False",
3004
 
                       "zeroconf": "True",
3005
 
                       }
3006
 
    del priority
3007
 
 
 
1994
    server_defaults = { "interface": "",
 
1995
                        "address": "",
 
1996
                        "port": "",
 
1997
                        "debug": "False",
 
1998
                        "priority":
 
1999
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2000
                        "servicename": "Mandos",
 
2001
                        "use_dbus": "True",
 
2002
                        "use_ipv6": "True",
 
2003
                        "debuglevel": "",
 
2004
                        "restore": "True",
 
2005
                        "statedir": "/var/lib/mandos"
 
2006
                        }
 
2007
    
3008
2008
    # Parse config file for server-global settings
3009
 
    server_config = configparser.ConfigParser(server_defaults)
 
2009
    server_config = configparser.SafeConfigParser(server_defaults)
3010
2010
    del server_defaults
3011
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3012
 
    # Convert the ConfigParser object to a dict
 
2011
    server_config.read(os.path.join(options.configdir,
 
2012
                                    "mandos.conf"))
 
2013
    # Convert the SafeConfigParser object to a dict
3013
2014
    server_settings = server_config.defaults()
3014
2015
    # Use the appropriate methods on the non-string config options
3015
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3016
 
                   "foreground", "zeroconf"):
 
2016
    for option in ("debug", "use_dbus", "use_ipv6"):
3017
2017
        server_settings[option] = server_config.getboolean("DEFAULT",
3018
2018
                                                           option)
3019
2019
    if server_settings["port"]:
3020
2020
        server_settings["port"] = server_config.getint("DEFAULT",
3021
2021
                                                       "port")
3022
 
    if server_settings["socket"]:
3023
 
        server_settings["socket"] = server_config.getint("DEFAULT",
3024
 
                                                         "socket")
3025
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
3026
 
        # over with an opened os.devnull.  But we don't want this to
3027
 
        # happen with a supplied network socket.
3028
 
        if 0 <= server_settings["socket"] <= 2:
3029
 
            server_settings["socket"] = os.dup(server_settings
3030
 
                                               ["socket"])
3031
2022
    del server_config
3032
 
 
 
2023
    
3033
2024
    # Override the settings from the config file with command line
3034
2025
    # options, if set.
3035
2026
    for option in ("interface", "address", "port", "debug",
3036
 
                   "priority", "servicename", "configdir", "use_dbus",
3037
 
                   "use_ipv6", "debuglevel", "restore", "statedir",
3038
 
                   "socket", "foreground", "zeroconf"):
 
2027
                   "priority", "servicename", "configdir",
 
2028
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2029
                   "statedir"):
3039
2030
        value = getattr(options, option)
3040
2031
        if value is not None:
3041
2032
            server_settings[option] = value
3042
2033
    del options
3043
2034
    # Force all strings to be unicode
3044
2035
    for option in server_settings.keys():
3045
 
        if isinstance(server_settings[option], bytes):
3046
 
            server_settings[option] = (server_settings[option]
3047
 
                                       .decode("utf-8"))
3048
 
    # Force all boolean options to be boolean
3049
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3050
 
                   "foreground", "zeroconf"):
3051
 
        server_settings[option] = bool(server_settings[option])
3052
 
    # Debug implies foreground
3053
 
    if server_settings["debug"]:
3054
 
        server_settings["foreground"] = True
 
2036
        if type(server_settings[option]) is str:
 
2037
            server_settings[option] = unicode(server_settings[option])
3055
2038
    # Now we have our good server settings in "server_settings"
3056
 
 
 
2039
    
3057
2040
    ##################################################################
3058
 
 
3059
 
    if (not server_settings["zeroconf"]
3060
 
        and not (server_settings["port"]
3061
 
                 or server_settings["socket"] != "")):
3062
 
        parser.error("Needs port or socket to work without Zeroconf")
3063
 
 
 
2041
    
3064
2042
    # For convenience
3065
2043
    debug = server_settings["debug"]
3066
2044
    debuglevel = server_settings["debuglevel"]
3068
2046
    use_ipv6 = server_settings["use_ipv6"]
3069
2047
    stored_state_path = os.path.join(server_settings["statedir"],
3070
2048
                                     stored_state_file)
3071
 
    foreground = server_settings["foreground"]
3072
 
    zeroconf = server_settings["zeroconf"]
3073
 
 
 
2049
    
3074
2050
    if debug:
3075
 
        initlogger(debug, logging.DEBUG)
 
2051
        initlogger(logging.DEBUG)
3076
2052
    else:
3077
2053
        if not debuglevel:
3078
 
            initlogger(debug)
 
2054
            initlogger()
3079
2055
        else:
3080
2056
            level = getattr(logging, debuglevel.upper())
3081
 
            initlogger(debug, level)
3082
 
 
 
2057
            initlogger(level)
 
2058
    
3083
2059
    if server_settings["servicename"] != "Mandos":
3084
 
        syslogger.setFormatter(
3085
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
3086
 
                              ' %(levelname)s: %(message)s'.format(
3087
 
                                  server_settings["servicename"])))
3088
 
 
 
2060
        syslogger.setFormatter(logging.Formatter
 
2061
                               ('Mandos (%s) [%%(process)d]:'
 
2062
                                ' %%(levelname)s: %%(message)s'
 
2063
                                % server_settings["servicename"]))
 
2064
    
3089
2065
    # Parse config file with clients
3090
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
2066
    client_defaults = { "timeout": "5m",
 
2067
                        "extended_timeout": "15m",
 
2068
                        "interval": "2m",
 
2069
                        "checker": "fping -q -- %%(host)s",
 
2070
                        "host": "",
 
2071
                        "approval_delay": "0s",
 
2072
                        "approval_duration": "1s",
 
2073
                        }
 
2074
    client_config = configparser.SafeConfigParser(client_defaults)
3091
2075
    client_config.read(os.path.join(server_settings["configdir"],
3092
2076
                                    "clients.conf"))
3093
 
 
 
2077
    
3094
2078
    global mandos_dbus_service
3095
2079
    mandos_dbus_service = None
3096
 
 
3097
 
    socketfd = None
3098
 
    if server_settings["socket"] != "":
3099
 
        socketfd = server_settings["socket"]
3100
 
    tcp_server = MandosServer(
3101
 
        (server_settings["address"], server_settings["port"]),
3102
 
        ClientHandler,
3103
 
        interface=(server_settings["interface"] or None),
3104
 
        use_ipv6=use_ipv6,
3105
 
        gnutls_priority=server_settings["priority"],
3106
 
        use_dbus=use_dbus,
3107
 
        socketfd=socketfd)
3108
 
    if not foreground:
3109
 
        pidfilename = "/run/mandos.pid"
3110
 
        if not os.path.isdir("/run/."):
3111
 
            pidfilename = "/var/run/mandos.pid"
3112
 
        pidfile = None
3113
 
        try:
3114
 
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3115
 
        except IOError as e:
3116
 
            logger.error("Could not open file %r", pidfilename,
3117
 
                         exc_info=e)
3118
 
 
3119
 
    for name, group in (("_mandos", "_mandos"),
3120
 
                        ("mandos", "mandos"),
3121
 
                        ("nobody", "nogroup")):
3122
 
        try:
3123
 
            uid = pwd.getpwnam(name).pw_uid
3124
 
            gid = pwd.getpwnam(group).pw_gid
3125
 
            break
 
2080
    
 
2081
    tcp_server = MandosServer((server_settings["address"],
 
2082
                               server_settings["port"]),
 
2083
                              ClientHandler,
 
2084
                              interface=(server_settings["interface"]
 
2085
                                         or None),
 
2086
                              use_ipv6=use_ipv6,
 
2087
                              gnutls_priority=
 
2088
                              server_settings["priority"],
 
2089
                              use_dbus=use_dbus)
 
2090
    if not debug:
 
2091
        pidfilename = "/var/run/mandos.pid"
 
2092
        try:
 
2093
            pidfile = open(pidfilename, "w")
 
2094
        except IOError:
 
2095
            logger.error("Could not open file %r", pidfilename)
 
2096
    
 
2097
    try:
 
2098
        uid = pwd.getpwnam("_mandos").pw_uid
 
2099
        gid = pwd.getpwnam("_mandos").pw_gid
 
2100
    except KeyError:
 
2101
        try:
 
2102
            uid = pwd.getpwnam("mandos").pw_uid
 
2103
            gid = pwd.getpwnam("mandos").pw_gid
3126
2104
        except KeyError:
3127
 
            continue
3128
 
    else:
3129
 
        uid = 65534
3130
 
        gid = 65534
 
2105
            try:
 
2106
                uid = pwd.getpwnam("nobody").pw_uid
 
2107
                gid = pwd.getpwnam("nobody").pw_gid
 
2108
            except KeyError:
 
2109
                uid = 65534
 
2110
                gid = 65534
3131
2111
    try:
3132
2112
        os.setgid(gid)
3133
2113
        os.setuid(uid)
3134
 
        if debug:
3135
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3136
 
                                                             gid))
3137
2114
    except OSError as error:
3138
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
3139
 
                       .format(uid, gid, os.strerror(error.errno)))
3140
 
        if error.errno != errno.EPERM:
3141
 
            raise
3142
 
 
 
2115
        if error[0] != errno.EPERM:
 
2116
            raise error
 
2117
    
3143
2118
    if debug:
3144
2119
        # Enable all possible GnuTLS debugging
3145
 
 
 
2120
        
3146
2121
        # "Use a log level over 10 to enable all debugging options."
3147
2122
        # - GnuTLS manual
3148
 
        gnutls.global_set_log_level(11)
3149
 
 
3150
 
        @gnutls.log_func
 
2123
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2124
        
 
2125
        @gnutls.library.types.gnutls_log_func
3151
2126
        def debug_gnutls(level, string):
3152
2127
            logger.debug("GnuTLS: %s", string[:-1])
3153
 
 
3154
 
        gnutls.global_set_log_function(debug_gnutls)
3155
 
 
 
2128
        
 
2129
        (gnutls.library.functions
 
2130
         .gnutls_global_set_log_function(debug_gnutls))
 
2131
        
3156
2132
        # Redirect stdin so all checkers get /dev/null
3157
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
2133
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3158
2134
        os.dup2(null, sys.stdin.fileno())
3159
2135
        if null > 2:
3160
2136
            os.close(null)
3161
 
 
 
2137
    else:
 
2138
        # No console logging
 
2139
        logger.removeHandler(console)
 
2140
    
3162
2141
    # Need to fork before connecting to D-Bus
3163
 
    if not foreground:
 
2142
    if not debug:
3164
2143
        # Close all input and output, do double fork, etc.
3165
2144
        daemon()
3166
 
 
3167
 
    if gi.version_info < (3, 10, 2):
3168
 
        # multiprocessing will use threads, so before we use GLib we
3169
 
        # need to inform GLib that threads will be used.
3170
 
        GLib.threads_init()
3171
 
 
 
2145
    
3172
2146
    global main_loop
3173
2147
    # From the Avahi example code
3174
 
    DBusGMainLoop(set_as_default=True)
3175
 
    main_loop = GLib.MainLoop()
 
2148
    DBusGMainLoop(set_as_default=True )
 
2149
    main_loop = gobject.MainLoop()
3176
2150
    bus = dbus.SystemBus()
3177
2151
    # End of Avahi example code
3178
2152
    if use_dbus:
3179
2153
        try:
3180
2154
            bus_name = dbus.service.BusName("se.recompile.Mandos",
3181
 
                                            bus,
3182
 
                                            do_not_queue=True)
3183
 
            old_bus_name = dbus.service.BusName(
3184
 
                "se.bsnet.fukt.Mandos", bus,
3185
 
                do_not_queue=True)
3186
 
        except dbus.exceptions.DBusException as e:
3187
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
2155
                                            bus, do_not_queue=True)
 
2156
            old_bus_name = (dbus.service.BusName
 
2157
                            ("se.bsnet.fukt.Mandos", bus,
 
2158
                             do_not_queue=True))
 
2159
        except dbus.exceptions.NameExistsException as e:
 
2160
            logger.error(unicode(e) + ", disabling D-Bus")
3188
2161
            use_dbus = False
3189
2162
            server_settings["use_dbus"] = False
3190
2163
            tcp_server.use_dbus = False
3191
 
    if zeroconf:
3192
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3193
 
        service = AvahiServiceToSyslog(
3194
 
            name=server_settings["servicename"],
3195
 
            servicetype="_mandos._tcp",
3196
 
            protocol=protocol,
3197
 
            bus=bus)
3198
 
        if server_settings["interface"]:
3199
 
            service.interface = if_nametoindex(
3200
 
                server_settings["interface"].encode("utf-8"))
3201
 
 
 
2164
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2165
    service = AvahiServiceToSyslog(name =
 
2166
                                   server_settings["servicename"],
 
2167
                                   servicetype = "_mandos._tcp",
 
2168
                                   protocol = protocol, bus = bus)
 
2169
    if server_settings["interface"]:
 
2170
        service.interface = (if_nametoindex
 
2171
                             (str(server_settings["interface"])))
 
2172
    
3202
2173
    global multiprocessing_manager
3203
2174
    multiprocessing_manager = multiprocessing.Manager()
3204
 
 
 
2175
    
3205
2176
    client_class = Client
3206
2177
    if use_dbus:
3207
 
        client_class = functools.partial(ClientDBus, bus=bus)
3208
 
 
3209
 
    client_settings = Client.config_parser(client_config)
 
2178
        client_class = functools.partial(ClientDBusTransitional,
 
2179
                                         bus = bus)
 
2180
    
 
2181
    special_settings = {
 
2182
        # Some settings need to be accessd by special methods;
 
2183
        # booleans need .getboolean(), etc.  Here is a list of them:
 
2184
        "approved_by_default":
 
2185
            lambda section:
 
2186
            client_config.getboolean(section, "approved_by_default"),
 
2187
        "enabled":
 
2188
            lambda section:
 
2189
            client_config.getboolean(section, "enabled"),
 
2190
        }
 
2191
    # Construct a new dict of client settings of this form:
 
2192
    # { client_name: {setting_name: value, ...}, ...}
 
2193
    # with exceptions for any special settings as defined above
 
2194
    client_settings = dict((clientname,
 
2195
                           dict((setting,
 
2196
                                 (value
 
2197
                                  if setting not in special_settings
 
2198
                                  else special_settings[setting]
 
2199
                                  (clientname)))
 
2200
                                for setting, value in
 
2201
                                client_config.items(clientname)))
 
2202
                          for clientname in client_config.sections())
 
2203
    
3210
2204
    old_client_settings = {}
3211
 
    clients_data = {}
3212
 
 
3213
 
    # This is used to redirect stdout and stderr for checker processes
3214
 
    global wnull
3215
 
    wnull = open(os.devnull, "w")  # A writable /dev/null
3216
 
    # Only used if server is running in foreground but not in debug
3217
 
    # mode
3218
 
    if debug or not foreground:
3219
 
        wnull.close()
3220
 
 
 
2205
    clients_data = []
 
2206
    
3221
2207
    # Get client data and settings from last running state.
3222
2208
    if server_settings["restore"]:
3223
2209
        try:
3224
2210
            with open(stored_state_path, "rb") as stored_state:
3225
 
                if sys.version_info.major == 2:
3226
 
                    clients_data, old_client_settings = pickle.load(
3227
 
                        stored_state)
3228
 
                else:
3229
 
                    bytes_clients_data, bytes_old_client_settings = (
3230
 
                        pickle.load(stored_state, encoding="bytes"))
3231
 
                    #   Fix bytes to strings
3232
 
                    #  clients_data
3233
 
                    # .keys()
3234
 
                    clients_data = {(key.decode("utf-8")
3235
 
                                     if isinstance(key, bytes)
3236
 
                                     else key): value
3237
 
                                    for key, value in
3238
 
                                    bytes_clients_data.items()}
3239
 
                    del bytes_clients_data
3240
 
                    for key in clients_data:
3241
 
                        value = {(k.decode("utf-8")
3242
 
                                  if isinstance(k, bytes) else k): v
3243
 
                                 for k, v in
3244
 
                                 clients_data[key].items()}
3245
 
                        clients_data[key] = value
3246
 
                        # .client_structure
3247
 
                        value["client_structure"] = [
3248
 
                            (s.decode("utf-8")
3249
 
                             if isinstance(s, bytes)
3250
 
                             else s) for s in
3251
 
                            value["client_structure"]]
3252
 
                        # .name, .host, and .checker_command
3253
 
                        for k in ("name", "host", "checker_command"):
3254
 
                            if isinstance(value[k], bytes):
3255
 
                                value[k] = value[k].decode("utf-8")
3256
 
                        if "key_id" not in value:
3257
 
                            value["key_id"] = ""
3258
 
                        elif "fingerprint" not in value:
3259
 
                            value["fingerprint"] = ""
3260
 
                    #  old_client_settings
3261
 
                    # .keys()
3262
 
                    old_client_settings = {
3263
 
                        (key.decode("utf-8")
3264
 
                         if isinstance(key, bytes)
3265
 
                         else key): value
3266
 
                        for key, value in
3267
 
                        bytes_old_client_settings.items()}
3268
 
                    del bytes_old_client_settings
3269
 
                    # .host and .checker_command
3270
 
                    for value in old_client_settings.values():
3271
 
                        for attribute in ("host", "checker_command"):
3272
 
                            if isinstance(value[attribute], bytes):
3273
 
                                value[attribute] = (value[attribute]
3274
 
                                                    .decode("utf-8"))
 
2211
                clients_data, old_client_settings = (pickle.load
 
2212
                                                     (stored_state))
3275
2213
            os.remove(stored_state_path)
3276
2214
        except IOError as e:
3277
 
            if e.errno == errno.ENOENT:
3278
 
                logger.warning("Could not load persistent state:"
3279
 
                               " {}".format(os.strerror(e.errno)))
3280
 
            else:
3281
 
                logger.critical("Could not load persistent state:",
3282
 
                                exc_info=e)
 
2215
            logger.warning("Could not load persistent state: {0}"
 
2216
                           .format(e))
 
2217
            if e.errno != errno.ENOENT:
3283
2218
                raise
3284
 
        except EOFError as e:
3285
 
            logger.warning("Could not load persistent state: "
3286
 
                           "EOFError:",
3287
 
                           exc_info=e)
3288
 
 
3289
 
    with PGPEngine() as pgp:
3290
 
        for client_name, client in clients_data.items():
3291
 
            # Skip removed clients
3292
 
            if client_name not in client_settings:
3293
 
                continue
3294
 
 
 
2219
    
 
2220
    with Crypto() as crypt:
 
2221
        for client in clients_data:
 
2222
            client_name = client["name"]
 
2223
            
3295
2224
            # Decide which value to use after restoring saved state.
3296
2225
            # We have three different values: Old config file,
3297
2226
            # new config file, and saved state.
3302
2231
                    # For each value in new config, check if it
3303
2232
                    # differs from the old config value (Except for
3304
2233
                    # the "secret" attribute)
3305
 
                    if (name != "secret"
3306
 
                        and (value !=
3307
 
                             old_client_settings[client_name][name])):
3308
 
                        client[name] = value
 
2234
                    if (name != "secret" and
 
2235
                        value != old_client_settings[client_name]
 
2236
                        [name]):
 
2237
                        setattr(client, name, value)
3309
2238
                except KeyError:
3310
2239
                    pass
3311
 
 
 
2240
            
3312
2241
            # Clients who has passed its expire date can still be
3313
 
            # enabled if its last checker was successful.  A Client
3314
 
            # whose checker succeeded before we stored its state is
3315
 
            # assumed to have successfully run all checkers during
3316
 
            # downtime.
3317
 
            if client["enabled"]:
3318
 
                if datetime.datetime.utcnow() >= client["expires"]:
3319
 
                    if not client["last_checked_ok"]:
3320
 
                        logger.warning(
3321
 
                            "disabling client {} - Client never "
3322
 
                            "performed a successful checker".format(
3323
 
                                client_name))
3324
 
                        client["enabled"] = False
3325
 
                    elif client["last_checker_status"] != 0:
3326
 
                        logger.warning(
3327
 
                            "disabling client {} - Client last"
3328
 
                            " checker failed with error code"
3329
 
                            " {}".format(
3330
 
                                client_name,
3331
 
                                client["last_checker_status"]))
 
2242
            # enabled if its last checker was sucessful.  Clients
 
2243
            # whose checker failed before we stored its state is
 
2244
            # assumed to have failed all checkers during downtime.
 
2245
            if client["enabled"] and client["last_checked_ok"]:
 
2246
                if ((datetime.datetime.utcnow()
 
2247
                     - client["last_checked_ok"])
 
2248
                    > client["interval"]):
 
2249
                    if client["last_checker_status"] != 0:
3332
2250
                        client["enabled"] = False
3333
2251
                    else:
3334
 
                        client["expires"] = (
3335
 
                            datetime.datetime.utcnow()
3336
 
                            + client["timeout"])
3337
 
                        logger.debug("Last checker succeeded,"
3338
 
                                     " keeping {} enabled".format(
3339
 
                                         client_name))
 
2252
                        client["expires"] = (datetime.datetime
 
2253
                                             .utcnow()
 
2254
                                             + client["timeout"])
 
2255
            
 
2256
            client["changedstate"] = (multiprocessing_manager
 
2257
                                      .Condition
 
2258
                                      (multiprocessing_manager
 
2259
                                       .Lock()))
 
2260
            if use_dbus:
 
2261
                new_client = (ClientDBusTransitional.__new__
 
2262
                              (ClientDBusTransitional))
 
2263
                tcp_server.clients[client_name] = new_client
 
2264
                new_client.bus = bus
 
2265
                for name, value in client.iteritems():
 
2266
                    setattr(new_client, name, value)
 
2267
                client_object_name = unicode(client_name).translate(
 
2268
                    {ord("."): ord("_"),
 
2269
                     ord("-"): ord("_")})
 
2270
                new_client.dbus_object_path = (dbus.ObjectPath
 
2271
                                               ("/clients/"
 
2272
                                                + client_object_name))
 
2273
                DBusObjectWithProperties.__init__(new_client,
 
2274
                                                  new_client.bus,
 
2275
                                                  new_client
 
2276
                                                  .dbus_object_path)
 
2277
            else:
 
2278
                tcp_server.clients[client_name] = (Client.__new__
 
2279
                                                   (Client))
 
2280
                for name, value in client.iteritems():
 
2281
                    setattr(tcp_server.clients[client_name],
 
2282
                            name, value)
 
2283
            
3340
2284
            try:
3341
 
                client["secret"] = pgp.decrypt(
3342
 
                    client["encrypted_secret"],
 
2285
                tcp_server.clients[client_name].secret = (
 
2286
                    crypt.decrypt(tcp_server.clients[client_name]
 
2287
                                  .encrypted_secret,
 
2288
                                  client_settings[client_name]
 
2289
                                  ["secret"]))
 
2290
            except CryptoError:
 
2291
                # If decryption fails, we use secret from new settings
 
2292
                tcp_server.clients[client_name].secret = (
3343
2293
                    client_settings[client_name]["secret"])
3344
 
            except PGPError:
3345
 
                # If decryption fails, we use secret from new settings
3346
 
                logger.debug("Failed to decrypt {} old secret".format(
3347
 
                    client_name))
3348
 
                client["secret"] = (client_settings[client_name]
3349
 
                                    ["secret"])
3350
 
 
3351
 
    # Add/remove clients based on new changes made to config
3352
 
    for client_name in (set(old_client_settings)
3353
 
                        - set(client_settings)):
3354
 
        del clients_data[client_name]
3355
 
    for client_name in (set(client_settings)
3356
 
                        - set(old_client_settings)):
3357
 
        clients_data[client_name] = client_settings[client_name]
3358
 
 
3359
 
    # Create all client objects
3360
 
    for client_name, client in clients_data.items():
3361
 
        tcp_server.clients[client_name] = client_class(
3362
 
            name=client_name,
3363
 
            settings=client,
3364
 
            server_settings=server_settings)
3365
 
 
 
2294
    
 
2295
    # Create/remove clients based on new changes made to config
 
2296
    for clientname in set(old_client_settings) - set(client_settings):
 
2297
        del tcp_server.clients[clientname]
 
2298
    for clientname in set(client_settings) - set(old_client_settings):
 
2299
        tcp_server.clients[clientname] = (client_class(name
 
2300
                                                       = clientname,
 
2301
                                                       config =
 
2302
                                                       client_settings
 
2303
                                                       [clientname]))
 
2304
    
3366
2305
    if not tcp_server.clients:
3367
2306
        logger.warning("No clients defined")
3368
 
 
3369
 
    if not foreground:
3370
 
        if pidfile is not None:
3371
 
            pid = os.getpid()
3372
 
            try:
3373
 
                with pidfile:
3374
 
                    print(pid, file=pidfile)
3375
 
            except IOError:
3376
 
                logger.error("Could not write to file %r with PID %d",
3377
 
                             pidfilename, pid)
3378
 
        del pidfile
 
2307
        
 
2308
    if not debug:
 
2309
        try:
 
2310
            with pidfile:
 
2311
                pid = os.getpid()
 
2312
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2313
            del pidfile
 
2314
        except IOError:
 
2315
            logger.error("Could not write to file %r with PID %d",
 
2316
                         pidfilename, pid)
 
2317
        except NameError:
 
2318
            # "pidfile" was never created
 
2319
            pass
3379
2320
        del pidfilename
3380
 
 
3381
 
    for termsig in (signal.SIGHUP, signal.SIGTERM):
3382
 
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3383
 
                             lambda: main_loop.quit() and False)
3384
 
 
 
2321
        
 
2322
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
2323
    
 
2324
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
2325
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
2326
    
3385
2327
    if use_dbus:
3386
 
 
3387
 
        @alternate_dbus_interfaces(
3388
 
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3389
 
        class MandosDBusService(DBusObjectWithObjectManager):
 
2328
        class MandosDBusService(dbus.service.Object):
3390
2329
            """A D-Bus proxy object"""
3391
 
 
3392
2330
            def __init__(self):
3393
2331
                dbus.service.Object.__init__(self, bus, "/")
3394
 
 
3395
2332
            _interface = "se.recompile.Mandos"
3396
 
 
 
2333
            
3397
2334
            @dbus.service.signal(_interface, signature="o")
3398
2335
            def ClientAdded(self, objpath):
3399
2336
                "D-Bus signal"
3400
2337
                pass
3401
 
 
 
2338
            
3402
2339
            @dbus.service.signal(_interface, signature="ss")
3403
 
            def ClientNotFound(self, key_id, address):
 
2340
            def ClientNotFound(self, fingerprint, address):
3404
2341
                "D-Bus signal"
3405
2342
                pass
3406
 
 
3407
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3408
 
                               "true"})
 
2343
            
3409
2344
            @dbus.service.signal(_interface, signature="os")
3410
2345
            def ClientRemoved(self, objpath, name):
3411
2346
                "D-Bus signal"
3412
2347
                pass
3413
 
 
3414
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3415
 
                               "true"})
 
2348
            
3416
2349
            @dbus.service.method(_interface, out_signature="ao")
3417
2350
            def GetAllClients(self):
3418
2351
                "D-Bus method"
3419
 
                return dbus.Array(c.dbus_object_path for c in
3420
 
                                  tcp_server.clients.values())
3421
 
 
3422
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3423
 
                               "true"})
 
2352
                return dbus.Array(c.dbus_object_path
 
2353
                                  for c in
 
2354
                                  tcp_server.clients.itervalues())
 
2355
            
3424
2356
            @dbus.service.method(_interface,
3425
2357
                                 out_signature="a{oa{sv}}")
3426
2358
            def GetAllClientsWithProperties(self):
3427
2359
                "D-Bus method"
3428
2360
                return dbus.Dictionary(
3429
 
                    {c.dbus_object_path: c.GetAll(
3430
 
                        "se.recompile.Mandos.Client")
3431
 
                     for c in tcp_server.clients.values()},
 
2361
                    ((c.dbus_object_path, c.GetAll(""))
 
2362
                     for c in tcp_server.clients.itervalues()),
3432
2363
                    signature="oa{sv}")
3433
 
 
 
2364
            
3434
2365
            @dbus.service.method(_interface, in_signature="o")
3435
2366
            def RemoveClient(self, object_path):
3436
2367
                "D-Bus method"
3437
 
                for c in tcp_server.clients.values():
 
2368
                for c in tcp_server.clients.itervalues():
3438
2369
                    if c.dbus_object_path == object_path:
3439
2370
                        del tcp_server.clients[c.name]
3440
2371
                        c.remove_from_connection()
3441
 
                        # Don't signal the disabling
 
2372
                        # Don't signal anything except ClientRemoved
3442
2373
                        c.disable(quiet=True)
3443
 
                        # Emit D-Bus signal for removal
3444
 
                        self.client_removed_signal(c)
 
2374
                        # Emit D-Bus signal
 
2375
                        self.ClientRemoved(object_path, c.name)
3445
2376
                        return
3446
2377
                raise KeyError(object_path)
3447
 
 
 
2378
            
3448
2379
            del _interface
3449
 
 
3450
 
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3451
 
                                 out_signature="a{oa{sa{sv}}}")
3452
 
            def GetManagedObjects(self):
3453
 
                """D-Bus method"""
3454
 
                return dbus.Dictionary(
3455
 
                    {client.dbus_object_path:
3456
 
                     dbus.Dictionary(
3457
 
                         {interface: client.GetAll(interface)
3458
 
                          for interface in
3459
 
                          client._get_all_interface_names()})
3460
 
                     for client in tcp_server.clients.values()})
3461
 
 
3462
 
            def client_added_signal(self, client):
3463
 
                """Send the new standard signal and the old signal"""
3464
 
                if use_dbus:
3465
 
                    # New standard signal
3466
 
                    self.InterfacesAdded(
3467
 
                        client.dbus_object_path,
3468
 
                        dbus.Dictionary(
3469
 
                            {interface: client.GetAll(interface)
3470
 
                             for interface in
3471
 
                             client._get_all_interface_names()}))
3472
 
                    # Old signal
3473
 
                    self.ClientAdded(client.dbus_object_path)
3474
 
 
3475
 
            def client_removed_signal(self, client):
3476
 
                """Send the new standard signal and the old signal"""
3477
 
                if use_dbus:
3478
 
                    # New standard signal
3479
 
                    self.InterfacesRemoved(
3480
 
                        client.dbus_object_path,
3481
 
                        client._get_all_interface_names())
3482
 
                    # Old signal
3483
 
                    self.ClientRemoved(client.dbus_object_path,
3484
 
                                       client.name)
3485
 
 
3486
 
        mandos_dbus_service = MandosDBusService()
3487
 
 
3488
 
    # Save modules to variables to exempt the modules from being
3489
 
    # unloaded before the function registered with atexit() is run.
3490
 
    mp = multiprocessing
3491
 
    wn = wnull
3492
 
 
 
2380
        
 
2381
        class MandosDBusServiceTransitional(MandosDBusService):
 
2382
            __metaclass__ = AlternateDBusNamesMetaclass
 
2383
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2384
    
3493
2385
    def cleanup():
3494
2386
        "Cleanup function; run on exit"
3495
 
        if zeroconf:
3496
 
            service.cleanup()
3497
 
 
3498
 
        mp.active_children()
3499
 
        wn.close()
 
2387
        service.cleanup()
 
2388
        
 
2389
        multiprocessing.active_children()
3500
2390
        if not (tcp_server.clients or client_settings):
3501
2391
            return
3502
 
 
 
2392
        
3503
2393
        # Store client before exiting. Secrets are encrypted with key
3504
2394
        # based on what config file has. If config file is
3505
2395
        # removed/edited, old secret will thus be unrecovable.
3506
 
        clients = {}
3507
 
        with PGPEngine() as pgp:
3508
 
            for client in tcp_server.clients.values():
 
2396
        clients = []
 
2397
        with Crypto() as crypt:
 
2398
            for client in tcp_server.clients.itervalues():
3509
2399
                key = client_settings[client.name]["secret"]
3510
 
                client.encrypted_secret = pgp.encrypt(client.secret,
3511
 
                                                      key)
 
2400
                client.encrypted_secret = crypt.encrypt(client.secret,
 
2401
                                                        key)
3512
2402
                client_dict = {}
3513
 
 
3514
 
                # A list of attributes that can not be pickled
3515
 
                # + secret.
3516
 
                exclude = {"bus", "changedstate", "secret",
3517
 
                           "checker", "server_settings"}
3518
 
                for name, typ in inspect.getmembers(dbus.service
3519
 
                                                    .Object):
 
2403
                
 
2404
                # A list of attributes that will not be stored when
 
2405
                # shutting down.
 
2406
                exclude = set(("bus", "changedstate", "secret"))
 
2407
                for name, typ in (inspect.getmembers
 
2408
                                  (dbus.service.Object)):
3520
2409
                    exclude.add(name)
3521
 
 
 
2410
                
3522
2411
                client_dict["encrypted_secret"] = (client
3523
2412
                                                   .encrypted_secret)
3524
2413
                for attr in client.client_structure:
3525
2414
                    if attr not in exclude:
3526
2415
                        client_dict[attr] = getattr(client, attr)
3527
 
 
3528
 
                clients[client.name] = client_dict
 
2416
                
 
2417
                clients.append(client_dict)
3529
2418
                del client_settings[client.name]["secret"]
3530
 
 
 
2419
        
3531
2420
        try:
3532
 
            with tempfile.NamedTemporaryFile(
3533
 
                    mode='wb',
3534
 
                    suffix=".pickle",
3535
 
                    prefix='clients-',
3536
 
                    dir=os.path.dirname(stored_state_path),
3537
 
                    delete=False) as stored_state:
3538
 
                pickle.dump((clients, client_settings), stored_state,
3539
 
                            protocol=2)
3540
 
                tempname = stored_state.name
3541
 
            os.rename(tempname, stored_state_path)
 
2421
            with os.fdopen(os.open(stored_state_path,
 
2422
                                   os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
 
2423
                                   0600), "wb") as stored_state:
 
2424
                pickle.dump((clients, client_settings), stored_state)
3542
2425
        except (IOError, OSError) as e:
3543
 
            if not debug:
3544
 
                try:
3545
 
                    os.remove(tempname)
3546
 
                except NameError:
3547
 
                    pass
3548
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3549
 
                logger.warning("Could not save persistent state: {}"
3550
 
                               .format(os.strerror(e.errno)))
3551
 
            else:
3552
 
                logger.warning("Could not save persistent state:",
3553
 
                               exc_info=e)
 
2426
            logger.warning("Could not save persistent state: {0}"
 
2427
                           .format(e))
 
2428
            if e.errno not in (errno.ENOENT, errno.EACCES):
3554
2429
                raise
3555
 
 
 
2430
        
3556
2431
        # Delete all clients, and settings from config
3557
2432
        while tcp_server.clients:
3558
2433
            name, client = tcp_server.clients.popitem()
3559
2434
            if use_dbus:
3560
2435
                client.remove_from_connection()
3561
 
            # Don't signal the disabling
 
2436
            # Don't signal anything except ClientRemoved
3562
2437
            client.disable(quiet=True)
3563
 
            # Emit D-Bus signal for removal
3564
2438
            if use_dbus:
3565
 
                mandos_dbus_service.client_removed_signal(client)
 
2439
                # Emit D-Bus signal
 
2440
                mandos_dbus_service.ClientRemoved(client
 
2441
                                                  .dbus_object_path,
 
2442
                                                  client.name)
3566
2443
        client_settings.clear()
3567
 
 
 
2444
    
3568
2445
    atexit.register(cleanup)
3569
 
 
3570
 
    for client in tcp_server.clients.values():
 
2446
    
 
2447
    for client in tcp_server.clients.itervalues():
3571
2448
        if use_dbus:
3572
 
            # Emit D-Bus signal for adding
3573
 
            mandos_dbus_service.client_added_signal(client)
 
2449
            # Emit D-Bus signal
 
2450
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
3574
2451
        # Need to initiate checking of clients
3575
2452
        if client.enabled:
3576
2453
            client.init_checker()
3577
 
 
 
2454
    
3578
2455
    tcp_server.enable()
3579
2456
    tcp_server.server_activate()
3580
 
 
 
2457
    
3581
2458
    # Find out what port we got
3582
 
    if zeroconf:
3583
 
        service.port = tcp_server.socket.getsockname()[1]
 
2459
    service.port = tcp_server.socket.getsockname()[1]
3584
2460
    if use_ipv6:
3585
2461
        logger.info("Now listening on address %r, port %d,"
3586
 
                    " flowinfo %d, scope_id %d",
3587
 
                    *tcp_server.socket.getsockname())
 
2462
                    " flowinfo %d, scope_id %d"
 
2463
                    % tcp_server.socket.getsockname())
3588
2464
    else:                       # IPv4
3589
 
        logger.info("Now listening on address %r, port %d",
3590
 
                    *tcp_server.socket.getsockname())
3591
 
 
3592
 
    # service.interface = tcp_server.socket.getsockname()[3]
3593
 
 
 
2465
        logger.info("Now listening on address %r, port %d"
 
2466
                    % tcp_server.socket.getsockname())
 
2467
    
 
2468
    #service.interface = tcp_server.socket.getsockname()[3]
 
2469
    
3594
2470
    try:
3595
 
        if zeroconf:
3596
 
            # From the Avahi example code
3597
 
            try:
3598
 
                service.activate()
3599
 
            except dbus.exceptions.DBusException as error:
3600
 
                logger.critical("D-Bus Exception", exc_info=error)
3601
 
                cleanup()
3602
 
                sys.exit(1)
3603
 
            # End of Avahi example code
3604
 
 
3605
 
        GLib.io_add_watch(
3606
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3607
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3608
 
            lambda *args, **kwargs: (tcp_server.handle_request
3609
 
                                     (*args[2:], **kwargs) or True))
3610
 
 
 
2471
        # From the Avahi example code
 
2472
        try:
 
2473
            service.activate()
 
2474
        except dbus.exceptions.DBusException as error:
 
2475
            logger.critical("DBusException: %s", error)
 
2476
            cleanup()
 
2477
            sys.exit(1)
 
2478
        # End of Avahi example code
 
2479
        
 
2480
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
2481
                             lambda *args, **kwargs:
 
2482
                             (tcp_server.handle_request
 
2483
                              (*args[2:], **kwargs) or True))
 
2484
        
3611
2485
        logger.debug("Starting main loop")
3612
2486
        main_loop.run()
3613
2487
    except AvahiError as error:
3614
 
        logger.critical("Avahi Error", exc_info=error)
 
2488
        logger.critical("AvahiError: %s", error)
3615
2489
        cleanup()
3616
2490
        sys.exit(1)
3617
2491
    except KeyboardInterrupt:
3622
2496
    # Must run before the D-Bus bus name gets deregistered
3623
2497
    cleanup()
3624
2498
 
3625
 
 
3626
 
def should_only_run_tests():
3627
 
    parser = argparse.ArgumentParser(add_help=False)
3628
 
    parser.add_argument("--check", action='store_true')
3629
 
    args, unknown_args = parser.parse_known_args()
3630
 
    run_tests = args.check
3631
 
    if run_tests:
3632
 
        # Remove --check argument from sys.argv
3633
 
        sys.argv[1:] = unknown_args
3634
 
    return run_tests
3635
 
 
3636
 
# Add all tests from doctest strings
3637
 
def load_tests(loader, tests, none):
3638
 
    import doctest
3639
 
    tests.addTests(doctest.DocTestSuite())
3640
 
    return tests
3641
2499
 
3642
2500
if __name__ == '__main__':
3643
 
    try:
3644
 
        if should_only_run_tests():
3645
 
            # Call using ./mandos --check [--verbose]
3646
 
            unittest.main()
3647
 
        else:
3648
 
            main()
3649
 
    finally:
3650
 
        logging.shutdown()
 
2501
    main()