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