/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: 2011-08-08 21:12:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110808211237-jejsz5brjytrjot8
* Makefile (DOCS): Added "intro.8mandos".
  (intro.8mandos, intro.8mandos.xhtml): New.
* README: Replaced text with link, reference and short summary.
* intro.xml: New.
* mandos-clients.conf.xml (SEE ALSO): Added "intro(8mandos)".
* mandos-ctl.xml (SEE ALSO): - '' -
* mandos-keygen.xml (SEE ALSO): - '' -
* mandos-monitor.xml (SEE ALSO): - '' -
* mandos.conf.xml (SEE ALSO): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.xml (SEE ALSO): - '' -
* plugins.d/askpass-fifo.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -
* plugins.d/password-prompt.xml (SEE ALSO): - '' -
* plugins.d/plymouth.xml (SEE ALSO): - '' -
* plugins.d/splashy.xml (SEE ALSO): - '' -
* plugins.d/usplash.xml (SEE ALSO): - '' -

Show diffs side-by-side

added added

removed removed

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