/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: 2019-08-01 19:52:59 UTC
  • Revision ID: teddy@recompile.se-20190801195259-nhu15rxjx3wz2kos
Break some long lines and refine documentation

* Makefile (LINUXVERSION): New.
  (LIBDIR): Break long line.
  (SYSTEMD, TMPFILES): Change ":=" to "=" to not run unless required.
  (run-client): Break long lines, and add two more harmless warnings
                to informational message.
  (install-server): Break long line.
  (install-client-nokey): - '' -
  (install-client): Shorten long line by using $(LINUXVERSION).
  (uninstall-client): - '' -

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