/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-02-11 05:14:10 UTC
  • Revision ID: teddy@recompile.se-20190211051410-43fmzhy0vlafw2pc
Fix warnings from -Wimplicit-fallthrough

* plugin-runner.c (main/parse_opt): Add __builtin_unreachable() after
                                    calls to argp_state_help().
* plugins.d/askpass-fifo.c (error_plus): Add __builtin_unreachable()
                                         after calls to error().
* plugins.d/mandos-client.c (main/parse_opt) Add
                                             __builtin_unreachable()
                                             after calls to
                                             argp_state_help().
* plugins.d/password-prompt.c: - '' -

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