/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-07 23:39:36 UTC
  • Revision ID: teddy@recompile.se-20160307233936-mhgpxhggamde443n
Server bug fix: Include CAP_SETGID so it does not run as root

* debian/mandos.postinst (configure): If old version was 1.7.4-1 or
  1.7.4-1~bpo8+1, fix situation where clients.pickle file is owned by
  root.
* mandos (main): Print debug info about setuid() and setgid()
* mandos.service ([Service]/CapabilityBoundingSet): Add "CAP_KILL
  CAP_SETGID"; the latter is needed for setgid() to be allowed.

Show diffs side-by-side

added added

removed removed

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