/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: 2018-02-10 13:23:58 UTC
  • Revision ID: teddy@recompile.se-20180210132358-8pfvo9vshq9l32y5
Remove unnecessary text left from old example init.d file

* init.d-mandos: Remove unnecessary text left from old example init.d
  file.

Show diffs side-by-side

added added

removed removed

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