/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

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