/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-23 07:11:22 UTC
  • Revision ID: teddy@recompile.se-20160323071122-55srtjdizr21rr7f
Use HTTPS in home page links

Since we have a real certificate now, change all links to the home
page to use HTTPS.

* README: Use HTTPS in home page links
* debian/control (Source: mandos/Homepage): - '' -
* debian/copyright (Source): - '' -
* intro.xml (SEE ALSO): - '' -
* mandos.lsm (Primary-site): - '' -

Show diffs side-by-side

added added

removed removed

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