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