/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-10-24 17:48:13 UTC
  • mto: This revision was merged to the branch mainline in revision 791.
  • Revision ID: teddy@recompile.se-20151024174813-56h6prp05qt30fx0
Tags: version-1.7.1-1
* Makefile (version): Changed to "1.7.1".
* NEWS (Version 1.7.1): New entry.
* debian/changelog (1.7.1-1): - '' -

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