/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: 2019-02-10 10:58:42 UTC
  • mfrom: (237.4.106 release)
  • Revision ID: teddy@recompile.se-20190210105842-l7htgtxjr23p4heb
Merge from release branch

Show diffs side-by-side

added added

removed removed

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