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