/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-07-27 10:11:45 UTC
  • Revision ID: teddy@recompile.se-20190727101145-jnpbpf8220gldbcd
Add dracut(8) support

Add support for the dracut(8) system for generating initramfs image
files; dracut is an alternative to the "initramfs-tools" package.

* .bzrignore (dracut-module/password-agent): Ignore new binary file.
* dracut-module: New directory for the dracut module.
* INSTALL (Prerequisites/Libraries/Mandos Client): Add dracut as an
                                                   alternative to
                                                   initramfs-tools,
                                                   and also add GLib.
* Makefile (DRACUTMODULE, GLIB_CFLAGS, GLIB_LIBS): New.
  (CPROGS): Add "dracut-module/password-agent".
  (DOCS): Add "dracut-module/password-agent.8mandos".
  (dracut-module/password-agent.8mandos): New.
  (dracut-module/password-agent.8mandos.xhtml): - '' -
  (dracut-module/password-agent): - '' -
  (check): Add command to run tests of password-agent(8mandos).
  (install-client-nokey): Also install the dracut module directory,
                          its files, and the password-agent(8mandos)
                          manual page.
  (install-client): To update the initramfs image file, run
                    update-initramfs or dracut depending on what is
                    installed.
  (uninstall-client): - '' - and also uninstall the the files in the
                      dracut module directory, that directory itself,
                      and the password-agent(8mandos) manual page.
* debian/control (Build-Depends): Add "libglib2.0-dev (>=2.40)".
  (Package: mandos-client/Depends): Add "dracut (>= 044+241-3)" as an
                                    alternative dependency to
                                    initramfs-tools.
  (Package: mandos-client/Conflicts): New; set to
                                      "dracut-config-generic".
  (debian/mandos-client.README.Debian): Document alternative commands
                                        to update the initramfs image
                                        for when dracut is used.
* debian/mandos-client.postinst (update_initramfs): Use alternative
                                                    commands to update
                                                    the initramfs
                                                    image for when
                                                    dracut is used.
* debian/tests/control (password-agent, password-agent-suid): Add two
                                                              new tests.
* dracut-module/ask-password-mandos.path: New.
* dracut-module/ask-password-mandos.service: - '' -
* dracut-module/cmdline-mandos.sh: - '' -
* dracut-module/module-setup.sh: - '' -
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: - '' -
* initramfs-unpack: Use the dracut "skipcpio" command, if available.
                    Also be more flexible and try hard to detect where
                    compressed data starts.
* plugins.d/mandos-client.xml (SECURITY): Be more precise that the
                                          mandos-client binary might
                                          not always be setuid, but
                                          that the program assumes
                                          that it has been started
                                          that way.
* plugins.d/password-prompt.c: Add new "--prompt" option.
  (conflict_detection): First try to detect the new PID file of
                        plymouth.
  (main): Define and use new "prompt" variable.
* plugins.d/password-prompt.xml (SYNOPSIS): Show new --prompt option.
  (DESCRIPTION): Describe new behavior of looking for plymouth PID
                 file.
  (OPTIONS): Document new "--prompt" option.
  (ENVIRONMENT): Clarify that the CRYPTTAB_SOURCE and CRYPTTAB_NAME
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the CRYPTTAB_SOURCE and
                 CRYPTTAB_NAME comes from, since this can now be
                 either initramfs-tools or dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference, and add commas
              to separate the other references.
* plugins.d/plymouth.c: Add new "--prompt" and "--debug" options.
  (debug): New global flag.
  (fprintf_plus): New function, used for debug output.
  (exec_and_wait): Add extra "const" to "argv" argument.
  (main): Define and use new "prompt" variable.  Add debug output.
  (main/options, main/parse_opt): New; used to parse options.
* plugins.d/plymouth.xml (SYNOPSIS): Show new options.
  (OPTIONS): Document new options.
  (ENVIRONMENT): Clarify that the cryptsource and crypttarget
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the cryptsource and crypttarget
                 comes from, since this can now be either
                 initramfs-tools or dracut.
  (EXAMPLE): Add an example using an option.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/splashy.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/usplash.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.

Show diffs side-by-side

added added

removed removed

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