/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2017-08-20 16:20:54 UTC
  • Revision ID: teddy@recompile.se-20170820162054-jwig602syxx2k4l0
Alter copyright notices slightly.  Actual license is unchanged!

This alters all copyright notices to use the Free Software
Foundation's recommendations for license notices; from
<https://www.gnu.org/licenses/gpl-howto.html>:

  For programs that are more than one file, it is better to replace
  “this program” with the name of the program, and begin the statement
  with a line saying “This file is part of NAME”.

* DBUS-API: Use program name "Mandos" explicitly in license notice.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* legalnotice.xml: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

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