/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: 2019-07-30 18:44:31 UTC
  • mto: This revision was merged to the branch mainline in revision 1134.
  • Revision ID: teddy@recompile.se-20190730184431-nqlgghaw2aqe6if6
Tags: version-1.8.5-1
* Makefile (version): Change to 1.8.5.
* NEWS (Version 1.8.5): Add new entry.
* debian/changelog (1.8.5-1): - '' -

Show diffs side-by-side

added added

removed removed

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