/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-10-05 20:58:06 UTC
  • mfrom: (237.4.84 release)
  • Revision ID: teddy@recompile.se-20161005205806-14z03l0dow1y69mj
Merge from release branch

Show diffs side-by-side

added added

removed removed

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