/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-05-31 15:56:58 UTC
  • Revision ID: teddy@recompile.se-20150531155658-l7znu7zlqr2dmuwd
mandos: Generate better messages in exceptions.

mandos (ProxyClient.__init__): Include fingerprint in KeyError().
(rfc3339_duration_to_delta): Include duration in ValueError().

Show diffs side-by-side

added added

removed removed

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