/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

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