/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2019-12-05 03:38:07 UTC
  • Revision ID: teddy@recompile.se-20191205033807-6awt45zpgp194vl1
From: Frans Spiesschaert <Frans.Spiesschaert@yucom.be>

Add Dutch debconf translation

* debian/po/nl.po: New.

Acked-by: Teddy Hogeborn <teddy@recompile.se>

Show diffs side-by-side

added added

removed removed

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