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