/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-05-23 20:18:34 UTC
  • mto: (237.7.304 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150523201834-e89ex4ito93yni8x
mandos: Use multiprocessing module to run checkers.

For a long time, the Mandos server has occasionally logged the message
"ERROR: Child process vanished".  This was never a fatal error, but it
has been annoying and slightly worrying, since a definite cause was
not found.  One potential cause could be the "multiprocessing" and
"subprocess" modules conflicting w.r.t. SIGCHLD.  To avoid this,
change the running of checkers from using subprocess.Popen
asynchronously to instead first create a multiprocessing.Process()
(which is asynchronous) calling a function, and have that function
then call subprocess.call() (which is synchronous).  In this way, the
only thing using any asynchronous subprocesses is the multiprocessing
module.

This makes it necessary to change one small thing in the D-Bus API,
since the subprocesses.call() function does not expose the raw wait(2)
status value.

DBUS-API (CheckerCompleted): Change the second value provided by this
                             D-Bus signal from the raw wait(2) status
                             to the actual terminating signal number.
mandos (subprocess_call_pipe): New function to be called by
                               multiprocessing.Process (starting a
                               separate process).
(Client.last_checker signal): New attribute for signal which
                              terminated last checker.  Like
                              last_checker_status, only not accessible
                              via D-Bus.
(Client.checker_callback): Take new "connection" argument and use it
                           to get returncode; set last_checker_signal.
                           Return False so gobject does not call this
                           callback again.
(Client.start_checker): Start checker using a multiprocessing.Process
                        instead of a subprocess.Popen.
(ClientDBus.checker_callback): Take new "connection" argument.        Call
                               Client.checker_callback early to have
                               it set last_checker_status and
                               last_checker_signal; use those.  Change
                               second value provided to D-Bus signal
                               CheckerCompleted to use
                               last_checker_signal if checker was
                               terminated by signal.
mandos-monitor: Update to reflect DBus API change.
(MandosClientWidget.checker_completed): Take "signal" instead of
                                        "condition" argument.  Use it
                                        accordingly.  Remove dead code
                                        (os.WCOREDUMP case).

Show diffs side-by-side

added added

removed removed

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