/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-04-03 03:01:02 UTC
  • Revision ID: teddy@recompile.se-20150403030102-xdxyaqcwc4wmqeyb
mandos: Do minor formatting and whitespace adjustments.

Show diffs side-by-side

added added

removed removed

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