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