/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-05-30 16:47:00 UTC
  • Revision ID: teddy@recompile.se-20150530164700-77zrd7964gdhbk1f
mandos: Disable D-Bus if any DBusException is raised when connecting.

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