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