/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: 2017-02-21 21:42:08 UTC
  • Revision ID: teddy@recompile.se-20170221214208-09wu1p4l2hjhqfoj
Use "read -r" in shell scripts to avoid backslash escapes

* initramfs-tools-hook: Use "read -r" to read filenames from network
  hook given the "files" argument.
* initramfs-tools-script: Use "read -e" when parsing
  "/conf/conf.d/cryptroot".
* mandos-keygen (keygen): Use "read -r" when reading passphrase.

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