/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-08-25 17:37:05 UTC
  • Revision ID: teddy@recompile.se-20160825173705-q2v6lban8ph9uw75
PEP8 compliance: mandos

* mandos: Add PEP8 compliance (as per the "pycodestyle" tool).

Show diffs side-by-side

added added

removed removed

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