/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-08-26 18:44:21 UTC
  • Revision ID: teddy@recompile.se-20160826184421-gjqjgzxy3lupx9n3
Fix bug where mandos server could not find GnuTLS library

* mandos (GnuTLS): Try to find both "gnutls" and variant name
                   "gnutls-deb0", for a Debian Jessie system which
                   does not have the package "gnutls28-dev" installed.

Show diffs side-by-side

added added

removed removed

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