/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-19 03:51:23 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 341.
  • Revision ID: teddy@recompile.se-20160319035123-53w4dbzdyjef29m1
Server: New tmpfiles.d file for persistent state directory

Provide a tmpfiles.d(5) file for systemd to create persistent state
directory on so-called "volatile" systems.

* Makefile (TMPFILES): New.
  (install-server): Also install "tmpfiles.d-mandos.conf" file as
                    "/usr/lib/tmpfiles.d/mandos.conf".
* tmpfiles.d-mandos.conf: New.

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