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