/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-02-28 03:01:43 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 331.
  • Revision ID: teddy@recompile.se-20160228030143-i6w90r7wzkvlx9kq
Stop using python-gnutls.  Use GnuTLS 3.3 or later directly.

* INSTALL: Document dependency on GnuTLS 3.3 and remove dependency on
          Python-GnuTLS.

* debian/control (Source: mandos/Build-Depends): Add (>= 3.3.0) to
                                                 "libgnutls28-dev" and
                                                 "gnutls-dev".
  (Source: mandos/Build-Depends-Indep): Remove "python2.7-gnutls".
  (Package: mandos/Depends): Remove "python-gnutls" and
                             "python2.7-gnutls", add "libgnutls28-dev
                             (>= 3.3.0) | libgnutls30 (>= 3.3.0)"
* mandos: Remove imports of "gnutls" and all submodules.
  (GnuTLS, gnutls): New; simulate a "gnutls" module.  Change all
                    callers to match new shorter names.

Show diffs side-by-side

added added

removed removed

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