/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-02-28 12:29:12 UTC
  • Revision ID: teddy@recompile.se-20160228122912-6yxw70vq8oze7ogc
Remove version specific packages from Debian dependencies.

* debian/control (Source: mandos/Build-Depends-Indep): Remove
  "python2.7", "python2.7-dbus", "python2.7-avahi", and
  "python2.7-gobject"; replace with "python (= 2.7)", "python-dbus",
  "python-avahi", "python-gobject".

Thanks: Scott Kitterman <debian@kitterman.com>
Closes: #811159

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