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-2017 Teddy Hogeborn
15
# Copyright © 2008-2017 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.15"
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
1464
try:
1465
dbus.OBJECT_MANAGER_IFACE
1466
except AttributeError:
1467
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1468
1469
1470
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1471
"""A D-Bus object with an ObjectManager.
1472
1473
Classes inheriting from this exposes the standard
1474
GetManagedObjects call and the InterfacesAdded and
1475
InterfacesRemoved signals on the standard
1476
"org.freedesktop.DBus.ObjectManager" interface.
1477
1478
Note: No signals are sent automatically; they must be sent
1479
manually.
1480
"""
1481
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1482
out_signature="a{oa{sa{sv}}}")
1483
def GetManagedObjects(self):
1484
"""This function must be overridden"""
1485
raise NotImplementedError()
1486
1487
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1488
signature="oa{sa{sv}}")
1489
def InterfacesAdded(self, object_path, interfaces_and_properties):
1490
pass
1491
1492
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1493
def InterfacesRemoved(self, object_path, interfaces):
1494
pass
1495
1496
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1497
out_signature="s",
1498
path_keyword='object_path',
1499
connection_keyword='connection')
1500
def Introspect(self, object_path, connection):
1501
"""Overloading of standard D-Bus method.
1502
1503
Override return argument name of GetManagedObjects to be
1504
"objpath_interfaces_and_properties"
1505
"""
1506
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1507
object_path,
1508
connection)
1509
try:
1510
document = xml.dom.minidom.parseString(xmlstring)
1511
1512
for if_tag in document.getElementsByTagName("interface"):
1513
# Fix argument name for the GetManagedObjects method
1514
if (if_tag.getAttribute("name")
1515
== dbus.OBJECT_MANAGER_IFACE):
1516
for cn in if_tag.getElementsByTagName("method"):
1517
if (cn.getAttribute("name")
1518
== "GetManagedObjects"):
1519
for arg in cn.getElementsByTagName("arg"):
1520
if (arg.getAttribute("direction")
1521
== "out"):
1522
arg.setAttribute(
1523
"name",
1524
"objpath_interfaces"
1525
"_and_properties")
1526
xmlstring = document.toxml("utf-8")
1527
document.unlink()
1528
except (AttributeError, xml.dom.DOMException,
1529
xml.parsers.expat.ExpatError) as error:
1530
logger.error("Failed to override Introspection method",
1531
exc_info=error)
1532
return xmlstring
1533
1534
1535
def datetime_to_dbus(dt, variant_level=0):
888
error)
889
return xmlstring
890
891
892
def datetime_to_dbus (dt, variant_level=0):
1536
893
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1537
894
if dt is None:
1538
return dbus.String("", variant_level=variant_level)
1539
return dbus.String(dt.isoformat(), variant_level=variant_level)
1540
1541
1542
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1543
"""A class decorator; applied to a subclass of
1544
dbus.service.Object, it will add alternate D-Bus attributes with
1545
interface names according to the "alt_interface_names" mapping.
1546
Usage:
1547
1548
@alternate_dbus_interfaces({"org.example.Interface":
1549
"net.example.AlternateInterface"})
1550
class SampleDBusObject(dbus.service.Object):
1551
@dbus.service.method("org.example.Interface")
1552
def SampleDBusMethod():
1553
pass
1554
1555
The above "SampleDBusMethod" on "SampleDBusObject" will be
1556
reachable via two interfaces: "org.example.Interface" and
1557
"net.example.AlternateInterface", the latter of which will have
1558
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1559
"true", unless "deprecate" is passed with a False value.
1560
1561
This works for methods and signals, and also for D-Bus properties
1562
(from DBusObjectWithProperties) and interfaces (from the
1563
dbus_interface_annotations decorator).
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.
1564
904
"""
1565
1566
def wrapper(cls):
1567
for orig_interface_name, alt_interface_name in (
1568
alt_interface_names.items()):
1569
attr = {}
1570
interface_names = set()
1571
# Go though all attributes of the class
1572
for attrname, attribute in inspect.getmembers(cls):
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):
1573
912
# Ignore non-D-Bus attributes, and D-Bus attributes
1574
913
# with the wrong interface name
1575
914
if (not hasattr(attribute, "_dbus_interface")
1576
or not attribute._dbus_interface.startswith(
1577
orig_interface_name)):
915
or not attribute._dbus_interface
916
.startswith("se.recompile.Mandos")):
1578
917
continue
1579
918
# Create an alternate D-Bus interface name based on
1580
919
# the current name
1581
alt_interface = attribute._dbus_interface.replace(
1582
orig_interface_name, alt_interface_name)
1583
interface_names.add(alt_interface)
920
alt_interface = (attribute._dbus_interface
921
.replace("se.recompile.Mandos",
922
"se.bsnet.fukt.Mandos"))
1584
923
# Is this a D-Bus signal?
1585
924
if getattr(attribute, "_dbus_is_signal", False):
1586
# Extract the original non-method undecorated
1587
# function by black magic
1588
if sys.version_info.major == 2:
1589
nonmethod_func = (dict(
925
# Extract the original non-method function by
926
# black magic
927
nonmethod_func = (dict(
1590
928
zip(attribute.func_code.co_freevars,
1591
attribute.__closure__))
1592
["func"].cell_contents)
1593
else:
1594
nonmethod_func = (dict(
1595
zip(attribute.__code__.co_freevars,
1596
attribute.__closure__))
1597
["func"].cell_contents)
929
attribute.__closure__))["func"]
930
.cell_contents)
1598
931
# Create a new, but exactly alike, function
1599
932
# object, and decorate it to be a new D-Bus signal
1600
933
# with the alternate D-Bus interface name
1601
new_function = copy_function(nonmethod_func)
1602
new_function = (dbus.service.signal(
1603
alt_interface,
1604
attribute._dbus_signature)(new_function))
1605
# Copy annotations, if any
1606
try:
1607
new_function._dbus_annotations = dict(
1608
attribute._dbus_annotations)
1609
except AttributeError:
1610
pass
1611
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)))
1612
943
# Define a creator of a function to call both the
1613
# original and alternate functions, so both the
1614
# original and alternate signals gets sent when
1615
# the function is called
944
# old and new functions, so both the old and new
945
# signals gets sent when the function is called
1616
946
def fixscope(func1, func2):
1617
947
"""This function is a scope container to pass
1618
948
func1 and func2 to the "call_both" function
1619
949
outside of its arguments"""
1620
1621
@functools.wraps(func2)
1622
950
def call_both(*args, **kwargs):
1623
951
"""This function will emit two D-Bus
1624
952
signals by calling func1 and func2"""
1625
953
func1(*args, **kwargs)
1626
954
func2(*args, **kwargs)
1627
# Make wrapper function look like a D-Bus
1628
# signal
1629
for name, attr in inspect.getmembers(func2):
1630
if name.startswith("_dbus_"):
1631
setattr(call_both, name, attr)
1632
1633
955
return call_both
1634
956
# Create the "call_both" function and add it to
1635
957
# the class
1636
attr[attrname] = fixscope(attribute, new_function)
958
attr[attrname] = fixscope(attribute,
959
new_function)
1637
960
# Is this a D-Bus method?
1638
961
elif getattr(attribute, "_dbus_is_method", False):
1639
962
# Create a new, but exactly alike, function
1640
963
# object. Decorate it to be a new D-Bus method
1641
964
# with the alternate D-Bus interface name. Add it
1642
965
# to the class.
1643
attr[attrname] = (
1644
dbus.service.method(
1645
alt_interface,
1646
attribute._dbus_in_signature,
1647
attribute._dbus_out_signature)
1648
(copy_function(attribute)))
1649
# Copy annotations, if any
1650
try:
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1653
except AttributeError:
1654
pass
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)))
1655
976
# Is this a D-Bus property?
1656
977
elif getattr(attribute, "_dbus_is_property", False):
1657
978
# Create a new, but exactly alike, function
1658
979
# object, and decorate it to be a new D-Bus
1659
980
# property with the alternate D-Bus interface
1660
981
# name. Add it to the class.
1661
attr[attrname] = (dbus_service_property(
1662
alt_interface, attribute._dbus_signature,
1663
attribute._dbus_access,
1664
attribute._dbus_get_args_options
1665
["byte_arrays"])
1666
(copy_function(attribute)))
1667
# Copy annotations, if any
1668
try:
1669
attr[attrname]._dbus_annotations = dict(
1670
attribute._dbus_annotations)
1671
except AttributeError:
1672
pass
1673
# Is this a D-Bus interface?
1674
elif getattr(attribute, "_dbus_is_interface", False):
1675
# Create a new, but exactly alike, function
1676
# object. Decorate it to be a new D-Bus interface
1677
# with the alternate D-Bus interface name. Add it
1678
# to the class.
1679
attr[attrname] = (
1680
dbus_interface_annotations(alt_interface)
1681
(copy_function(attribute)))
1682
if deprecate:
1683
# Deprecate all alternate interfaces
1684
iname = "_AlternateDBusNames_interface_annotation{}"
1685
for interface_name in interface_names:
1686
1687
@dbus_interface_annotations(interface_name)
1688
def func(self):
1689
return {"org.freedesktop.DBus.Deprecated":
1690
"true"}
1691
# Find an unused name
1692
for aname in (iname.format(i)
1693
for i in itertools.count()):
1694
if aname not in attr:
1695
attr[aname] = func
1696
break
1697
if interface_names:
1698
# Replace the class with a new subclass of it with
1699
# methods, signals, etc. as created above.
1700
if sys.version_info.major == 2:
1701
cls = type(b"{}Alternate".format(cls.__name__),
1702
(cls, ), attr)
1703
else:
1704
cls = type("{}Alternate".format(cls.__name__),
1705
(cls, ), attr)
1706
return cls
1707
1708
return wrapper
1709
1710
1711
@alternate_dbus_interfaces({"se.recompile.Mandos":
1712
"se.bsnet.fukt.Mandos"})
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
1713
998
class ClientDBus(Client, DBusObjectWithProperties):
1714
999
"""A Client class using D-Bus
1715
1000
1716
1001
Attributes:
1717
1002
dbus_object_path: dbus.ObjectPath
1718
1003
bus: dbus.SystemBus()
1719
1004
"""
1720
1005
1721
1006
runtime_expansions = (Client.runtime_expansions
1722
+ ("dbus_object_path", ))
1723
1724
_interface = "se.recompile.Mandos.Client"
1725
1007
+ ("dbus_object_path",))
1008
1726
1009
# dbus.service.Object doesn't use super(), so we can't either.
1727
1728
def __init__(self, bus=None, *args, **kwargs):
1010
1011
def __init__(self, bus = None, *args, **kwargs):
1729
1012
self.bus = bus
1730
1013
Client.__init__(self, *args, **kwargs)
1014
1015
self._approvals_pending = 0
1731
1016
# Only now, when this client is initialized, can it show up on
1732
1017
# the D-Bus
1733
client_object_name = str(self.name).translate(
1018
client_object_name = unicode(self.name).translate(
1734
1019
{ord("."): ord("_"),
1735
1020
ord("-"): ord("_")})
1736
self.dbus_object_path = dbus.ObjectPath(
1737
"/clients/" + client_object_name)
1021
self.dbus_object_path = (dbus.ObjectPath
1022
("/clients/" + client_object_name))
1738
1023
DBusObjectWithProperties.__init__(self, self.bus,
1739
1024
self.dbus_object_path)
1740
1741
def notifychangeproperty(transform_func, dbus_name,
1742
type_func=lambda x: x,
1743
variant_level=1,
1744
invalidate_only=False,
1745
_interface=_interface):
1025
1026
def notifychangeproperty(transform_func,
1027
dbus_name, type_func=lambda x: x,
1028
variant_level=1):
1746
1029
""" Modify a variable so that it's a property which announces
1747
1030
its changes to DBus.
1748
1031
1749
1032
transform_fun: Function that takes a value and a variant_level
1750
1033
and transforms it to a D-Bus type.
1751
1034
dbus_name: D-Bus name of the variable
1753
1036
to the D-Bus. Default: no transform
1754
1037
variant_level: D-Bus variant level. Default: 1
1755
1038
"""
1756
attrname = "_{}".format(dbus_name)
1757
1039
attrname = "_{0}".format(dbus_name)
1758
1040
def setter(self, value):
1759
1041
if hasattr(self, "dbus_object_path"):
1760
1042
if (not hasattr(self, attrname) or
1761
1043
type_func(getattr(self, attrname, None))
1762
1044
!= type_func(value)):
1763
if invalidate_only:
1764
self.PropertiesChanged(
1765
_interface, dbus.Dictionary(),
1766
dbus.Array((dbus_name, )))
1767
else:
1768
dbus_value = transform_func(
1769
type_func(value),
1770
variant_level=variant_level)
1771
self.PropertyChanged(dbus.String(dbus_name),
1772
dbus_value)
1773
self.PropertiesChanged(
1774
_interface,
1775
dbus.Dictionary({dbus.String(dbus_name):
1776
dbus_value}),
1777
dbus.Array())
1045
dbus_value = transform_func(type_func(value),
1046
variant_level
1047
=variant_level)
1048
self.PropertyChanged(dbus.String(dbus_name),
1049
dbus_value)
1778
1050
setattr(self, attrname, value)
1779
1051
1780
1052
return property(lambda self: getattr(self, attrname), setter)
1781
1053
1054
1782
1055
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1783
1056
approvals_pending = notifychangeproperty(dbus.Boolean,
1784
1057
"ApprovalPending",
1785
type_func=bool)
1058
type_func = bool)
1786
1059
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1787
1060
last_enabled = notifychangeproperty(datetime_to_dbus,
1788
1061
"LastEnabled")
1789
checker = notifychangeproperty(
1790
dbus.Boolean, "CheckerRunning",
1791
type_func=lambda checker: checker is not None)
1062
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1063
type_func = lambda checker:
1064
checker is not None)
1792
1065
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1793
1066
"LastCheckedOK")
1794
last_checker_status = notifychangeproperty(dbus.Int16,
1795
"LastCheckerStatus")
1796
1067
last_approval_request = notifychangeproperty(
1797
1068
datetime_to_dbus, "LastApprovalRequest")
1798
1069
approved_by_default = notifychangeproperty(dbus.Boolean,
1799
1070
"ApprovedByDefault")
1800
approval_delay = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDelay",
1802
type_func=lambda td: td.total_seconds() * 1000)
1071
approval_delay = notifychangeproperty(dbus.UInt16,
1072
"ApprovalDelay",
1073
type_func =
1074
_timedelta_to_milliseconds)
1803
1075
approval_duration = notifychangeproperty(
1804
dbus.UInt64, "ApprovalDuration",
1805
type_func=lambda td: td.total_seconds() * 1000)
1076
dbus.UInt16, "ApprovalDuration",
1077
type_func = _timedelta_to_milliseconds)
1806
1078
host = notifychangeproperty(dbus.String, "Host")
1807
timeout = notifychangeproperty(
1808
dbus.UInt64, "Timeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
1079
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1080
type_func =
1081
_timedelta_to_milliseconds)
1810
1082
extended_timeout = notifychangeproperty(
1811
dbus.UInt64, "ExtendedTimeout",
1812
type_func=lambda td: td.total_seconds() * 1000)
1813
interval = notifychangeproperty(
1814
dbus.UInt64, "Interval",
1815
type_func=lambda td: td.total_seconds() * 1000)
1083
dbus.UInt16, "ExtendedTimeout",
1084
type_func = _timedelta_to_milliseconds)
1085
interval = notifychangeproperty(dbus.UInt16,
1086
"Interval",
1087
type_func =
1088
_timedelta_to_milliseconds)
1816
1089
checker_command = notifychangeproperty(dbus.String, "Checker")
1817
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1818
invalidate_only=True)
1819
1090
1820
1091
del notifychangeproperty
1821
1092
1822
1093
def __del__(self, *args, **kwargs):
1823
1094
try:
1824
1095
self.remove_from_connection()
1827
1098
if hasattr(DBusObjectWithProperties, "__del__"):
1828
1099
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1829
1100
Client.__del__(self, *args, **kwargs)
1830
1831
def checker_callback(self, source, condition,
1832
connection, command, *args, **kwargs):
1833
ret = Client.checker_callback(self, source, condition,
1834
connection, command, *args,
1835
**kwargs)
1836
exitstatus = self.last_checker_status
1837
if exitstatus >= 0:
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)
1838
1108
# Emit D-Bus signal
1839
1109
self.CheckerCompleted(dbus.Int16(exitstatus),
1840
# This is specific to GNU libC
1841
dbus.Int64(exitstatus << 8),
1110
dbus.Int64(condition),
1842
1111
dbus.String(command))
1843
1112
else:
1844
1113
# Emit D-Bus signal
1845
1114
self.CheckerCompleted(dbus.Int16(-1),
1846
dbus.Int64(
1847
# This is specific to GNU libC
1848
(exitstatus << 8)
1849
| self.last_checker_signal),
1115
dbus.Int64(condition),
1850
1116
dbus.String(command))
1851
return ret
1852
1117
1118
return Client.checker_callback(self, pid, condition, command,
1119
*args, **kwargs)
1120
1853
1121
def start_checker(self, *args, **kwargs):
1854
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
1855
1127
r = Client.start_checker(self, *args, **kwargs)
1856
1128
# Only if new checker process was started
1857
1129
if (self.checker is not None
1859
1131
# Emit D-Bus signal
1860
1132
self.CheckerStarted(self.current_checker_command)
1861
1133
return r
1862
1134
1863
1135
def _reset_approved(self):
1864
self.approved = None
1136
self._approved = None
1865
1137
return False
1866
1138
1867
1139
def approve(self, value=True):
1868
self.approved = value
1869
GLib.timeout_add(int(self.approval_duration.total_seconds()
1870
* 1000), self._reset_approved)
1871
1140
self.send_changedstate()
1872
1873
# D-Bus methods, signals & properties
1874
1875
# Interfaces
1876
1877
# Signals
1878
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
1879
1152
# CheckerCompleted - signal
1880
1153
@dbus.service.signal(_interface, signature="nxs")
1881
1154
def CheckerCompleted(self, exitcode, waitstatus, command):
1882
1155
"D-Bus signal"
1883
1156
pass
1884
1157
1885
1158
# CheckerStarted - signal
1886
1159
@dbus.service.signal(_interface, signature="s")
1887
1160
def CheckerStarted(self, command):
1888
1161
"D-Bus signal"
1889
1162
pass
1890
1163
1891
1164
# PropertyChanged - signal
1892
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1893
1165
@dbus.service.signal(_interface, signature="sv")
1894
1166
def PropertyChanged(self, property, value):
1895
1167
"D-Bus signal"
1896
1168
pass
1897
1169
1898
1170
# GotSecret - signal
1899
1171
@dbus.service.signal(_interface)
1900
1172
def GotSecret(self):
1903
1175
server to mandos-client
1904
1176
"""
1905
1177
pass
1906
1178
1907
1179
# Rejected - signal
1908
1180
@dbus.service.signal(_interface, signature="s")
1909
1181
def Rejected(self, reason):
1910
1182
"D-Bus signal"
1911
1183
pass
1912
1184
1913
1185
# NeedApproval - signal
1914
1186
@dbus.service.signal(_interface, signature="tb")
1915
1187
def NeedApproval(self, timeout, default):
1916
1188
"D-Bus signal"
1917
1189
return self.need_approval()
1918
1919
# Methods
1920
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
1921
1201
# Approve - method
1922
1202
@dbus.service.method(_interface, in_signature="b")
1923
1203
def Approve(self, value):
1924
1204
self.approve(value)
1925
1205
1926
1206
# CheckedOK - method
1927
1207
@dbus.service.method(_interface)
1928
1208
def CheckedOK(self):
1929
1209
self.checked_ok()
1930
1210
1931
1211
# Enable - method
1932
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1933
1212
@dbus.service.method(_interface)
1934
1213
def Enable(self):
1935
1214
"D-Bus method"
1936
1215
self.enable()
1937
1216
1938
1217
# StartChecker - method
1939
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1940
1218
@dbus.service.method(_interface)
1941
1219
def StartChecker(self):
1942
1220
"D-Bus method"
1943
1221
self.start_checker()
1944
1222
1945
1223
# Disable - method
1946
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1947
1224
@dbus.service.method(_interface)
1948
1225
def Disable(self):
1949
1226
"D-Bus method"
1950
1227
self.disable()
1951
1228
1952
1229
# StopChecker - method
1953
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1954
1230
@dbus.service.method(_interface)
1955
1231
def StopChecker(self):
1956
1232
self.stop_checker()
1957
1958
# Properties
1959
1233
1234
## Properties
1235
1960
1236
# ApprovalPending - property
1961
1237
@dbus_service_property(_interface, signature="b", access="read")
1962
1238
def ApprovalPending_dbus_property(self):
1963
1239
return dbus.Boolean(bool(self.approvals_pending))
1964
1240
1965
1241
# ApprovedByDefault - property
1966
@dbus_service_property(_interface,
1967
signature="b",
1242
@dbus_service_property(_interface, signature="b",
1968
1243
access="readwrite")
1969
1244
def ApprovedByDefault_dbus_property(self, value=None):
1970
1245
if value is None: # get
1971
1246
return dbus.Boolean(self.approved_by_default)
1972
1247
self.approved_by_default = bool(value)
1973
1248
1974
1249
# ApprovalDelay - property
1975
@dbus_service_property(_interface,
1976
signature="t",
1250
@dbus_service_property(_interface, signature="t",
1977
1251
access="readwrite")
1978
1252
def ApprovalDelay_dbus_property(self, value=None):
1979
1253
if value is None: # get
1980
return dbus.UInt64(self.approval_delay.total_seconds()
1981
* 1000)
1254
return dbus.UInt64(self.approval_delay_milliseconds())
1982
1255
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1983
1256
1984
1257
# ApprovalDuration - property
1985
@dbus_service_property(_interface,
1986
signature="t",
1258
@dbus_service_property(_interface, signature="t",
1987
1259
access="readwrite")
1988
1260
def ApprovalDuration_dbus_property(self, value=None):
1989
1261
if value is None: # get
1990
return dbus.UInt64(self.approval_duration.total_seconds()
1991
* 1000)
1262
return dbus.UInt64(_timedelta_to_milliseconds(
1263
self.approval_duration))
1992
1264
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1993
1265
1994
1266
# Name - property
1995
@dbus_annotations(
1996
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1997
1267
@dbus_service_property(_interface, signature="s", access="read")
1998
1268
def Name_dbus_property(self):
1999
1269
return dbus.String(self.name)
2000
1270
2001
1271
# Fingerprint - property
2002
@dbus_annotations(
2003
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2004
1272
@dbus_service_property(_interface, signature="s", access="read")
2005
1273
def Fingerprint_dbus_property(self):
2006
1274
return dbus.String(self.fingerprint)
2007
1275
2008
1276
# Host - property
2009
@dbus_service_property(_interface,
2010
signature="s",
1277
@dbus_service_property(_interface, signature="s",
2011
1278
access="readwrite")
2012
1279
def Host_dbus_property(self, value=None):
2013
1280
if value is None: # get
2014
1281
return dbus.String(self.host)
2015
self.host = str(value)
2016
1282
self.host = value
1283
2017
1284
# Created - property
2018
@dbus_annotations(
2019
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2020
1285
@dbus_service_property(_interface, signature="s", access="read")
2021
1286
def Created_dbus_property(self):
2022
1287
return datetime_to_dbus(self.created)
2023
1288
2024
1289
# LastEnabled - property
2025
1290
@dbus_service_property(_interface, signature="s", access="read")
2026
1291
def LastEnabled_dbus_property(self):
2027
1292
return datetime_to_dbus(self.last_enabled)
2028
1293
2029
1294
# Enabled - property
2030
@dbus_service_property(_interface,
2031
signature="b",
1295
@dbus_service_property(_interface, signature="b",
2032
1296
access="readwrite")
2033
1297
def Enabled_dbus_property(self, value=None):
2034
1298
if value is None: # get
2037
1301
self.enable()
2038
1302
else:
2039
1303
self.disable()
2040
1304
2041
1305
# LastCheckedOK - property
2042
@dbus_service_property(_interface,
2043
signature="s",
1306
@dbus_service_property(_interface, signature="s",
2044
1307
access="readwrite")
2045
1308
def LastCheckedOK_dbus_property(self, value=None):
2046
1309
if value is not None:
2047
1310
self.checked_ok()
2048
1311
return
2049
1312
return datetime_to_dbus(self.last_checked_ok)
2050
2051
# LastCheckerStatus - property
2052
@dbus_service_property(_interface, signature="n", access="read")
2053
def LastCheckerStatus_dbus_property(self):
2054
return dbus.Int16(self.last_checker_status)
2055
1313
2056
1314
# Expires - property
2057
1315
@dbus_service_property(_interface, signature="s", access="read")
2058
1316
def Expires_dbus_property(self):
2059
1317
return datetime_to_dbus(self.expires)
2060
1318
2061
1319
# LastApprovalRequest - property
2062
1320
@dbus_service_property(_interface, signature="s", access="read")
2063
1321
def LastApprovalRequest_dbus_property(self):
2064
1322
return datetime_to_dbus(self.last_approval_request)
2065
1323
2066
1324
# Timeout - property
2067
@dbus_service_property(_interface,
2068
signature="t",
1325
@dbus_service_property(_interface, signature="t",
2069
1326
access="readwrite")
2070
1327
def Timeout_dbus_property(self, value=None):
2071
1328
if value is None: # get
2072
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2073
old_timeout = self.timeout
1329
return dbus.UInt64(self.timeout_milliseconds())
2074
1330
self.timeout = datetime.timedelta(0, 0, 0, value)
2075
# Reschedule disabling
2076
if self.enabled:
2077
now = datetime.datetime.utcnow()
2078
self.expires += self.timeout - old_timeout
2079
if self.expires <= now:
2080
# The timeout has passed
2081
self.disable()
2082
else:
2083
if (getattr(self, "disable_initiator_tag", None)
2084
is None):
2085
return
2086
GLib.source_remove(self.disable_initiator_tag)
2087
self.disable_initiator_tag = GLib.timeout_add(
2088
int((self.expires - now).total_seconds() * 1000),
2089
self.disable)
2090
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
2091
1352
# ExtendedTimeout - property
2092
@dbus_service_property(_interface,
2093
signature="t",
1353
@dbus_service_property(_interface, signature="t",
2094
1354
access="readwrite")
2095
1355
def ExtendedTimeout_dbus_property(self, value=None):
2096
1356
if value is None: # get
2097
return dbus.UInt64(self.extended_timeout.total_seconds()
2098
* 1000)
1357
return dbus.UInt64(self.extended_timeout_milliseconds())
2099
1358
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2100
1359
2101
1360
# Interval - property
2102
@dbus_service_property(_interface,
2103
signature="t",
1361
@dbus_service_property(_interface, signature="t",
2104
1362
access="readwrite")
2105
1363
def Interval_dbus_property(self, value=None):
2106
1364
if value is None: # get
2107
return dbus.UInt64(self.interval.total_seconds() * 1000)
1365
return dbus.UInt64(self.interval_milliseconds())
2108
1366
self.interval = datetime.timedelta(0, 0, 0, value)
2109
1367
if getattr(self, "checker_initiator_tag", None) is None:
2110
1368
return
2111
1369
if self.enabled:
2112
1370
# Reschedule checker run
2113
GLib.source_remove(self.checker_initiator_tag)
2114
self.checker_initiator_tag = GLib.timeout_add(
2115
value, self.start_checker)
2116
self.start_checker() # Start one now, too
2117
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
2118
1376
# Checker - property
2119
@dbus_service_property(_interface,
2120
signature="s",
1377
@dbus_service_property(_interface, signature="s",
2121
1378
access="readwrite")
2122
1379
def Checker_dbus_property(self, value=None):
2123
1380
if value is None: # get
2124
1381
return dbus.String(self.checker_command)
2125
self.checker_command = str(value)
2126
1382
self.checker_command = value
1383
2127
1384
# CheckerRunning - property
2128
@dbus_service_property(_interface,
2129
signature="b",
1385
@dbus_service_property(_interface, signature="b",
2130
1386
access="readwrite")
2131
1387
def CheckerRunning_dbus_property(self, value=None):
2132
1388
if value is None: # get
2135
1391
self.start_checker()
2136
1392
else:
2137
1393
self.stop_checker()
2138
1394
2139
1395
# ObjectPath - property
2140
@dbus_annotations(
2141
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2142
"org.freedesktop.DBus.Deprecated": "true"})
2143
1396
@dbus_service_property(_interface, signature="o", access="read")
2144
1397
def ObjectPath_dbus_property(self):
2145
return self.dbus_object_path # is already a dbus.ObjectPath
2146
1398
return self.dbus_object_path # is already a dbus.ObjectPath
1399
2147
1400
# Secret = property
2148
@dbus_annotations(
2149
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2150
"invalidates"})
2151
@dbus_service_property(_interface,
2152
signature="ay",
2153
access="write",
2154
byte_arrays=True)
1401
@dbus_service_property(_interface, signature="ay",
1402
access="write", byte_arrays=True)
2155
1403
def Secret_dbus_property(self, value):
2156
self.secret = bytes(value)
2157
1404
self.secret = str(value)
1405
2158
1406
del _interface
2159
1407
2160
1408
2163
1411
self._pipe = child_pipe
2164
1412
self._pipe.send(('init', fpr, address))
2165
1413
if not self._pipe.recv():
2166
raise KeyError(fpr)
2167
1414
raise KeyError()
1415
2168
1416
def __getattribute__(self, name):
2169
if name == '_pipe':
1417
if(name == '_pipe'):
2170
1418
return super(ProxyClient, self).__getattribute__(name)
2171
1419
self._pipe.send(('getattr', name))
2172
1420
data = self._pipe.recv()
2173
1421
if data[0] == 'data':
2174
1422
return data[1]
2175
1423
if data[0] == 'function':
2176
2177
1424
def func(*args, **kwargs):
2178
1425
self._pipe.send(('funcall', name, args, kwargs))
2179
1426
return self._pipe.recv()[1]
2180
2181
1427
return func
2182
1428
2183
1429
def __setattr__(self, name, value):
2184
if name == '_pipe':
1430
if(name == '_pipe'):
2185
1431
return super(ProxyClient, self).__setattr__(name, value)
2186
1432
self._pipe.send(('setattr', name, value))
2187
1433
2188
1434
1435
class ClientDBusTransitional(ClientDBus):
1436
__metaclass__ = AlternateDBusNamesMetaclass
1437
1438
2189
1439
class ClientHandler(socketserver.BaseRequestHandler, object):
2190
1440
"""A class to handle client connections.
2191
1441
2192
1442
Instantiated once for each connection to handle it.
2193
1443
Note: This will run in its own forked process."""
2194
1444
2195
1445
def handle(self):
2196
1446
with contextlib.closing(self.server.child_pipe) as child_pipe:
2197
1447
logger.info("TCP connection from: %s",
2198
str(self.client_address))
1448
unicode(self.client_address))
2199
1449
logger.debug("Pipe FD: %d",
2200
1450
self.server.child_pipe.fileno())
2201
2202
session = gnutls.ClientSession(self.request)
2203
2204
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2205
# "+AES-256-CBC", "+SHA1",
2206
# "+COMP-NULL", "+CTYPE-OPENPGP",
2207
# "+DHE-DSS"))
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"))
2208
1466
# Use a fallback default, since this MUST be set.
2209
1467
priority = self.server.gnutls_priority
2210
1468
if priority is None:
2211
1469
priority = "NORMAL"
2212
gnutls.priority_set_direct(session._c_object,
2213
priority.encode("utf-8"),
2214
None)
2215
1470
(gnutls.library.functions
1471
.gnutls_priority_set_direct(session._c_object,
1472
priority, None))
1473
2216
1474
# Start communication using the Mandos protocol
2217
1475
# Get protocol number
2218
1476
line = self.request.makefile().readline()
2219
1477
logger.debug("Protocol version: %r", line)
2220
1478
try:
2221
1479
if int(line.strip().split()[0]) > 1:
2222
raise RuntimeError(line)
1480
raise RuntimeError
2223
1481
except (ValueError, IndexError, RuntimeError) as error:
2224
1482
logger.error("Unknown protocol version: %s", error)
2225
1483
return
2226
1484
2227
1485
# Start GnuTLS connection
2228
1486
try:
2229
1487
session.handshake()
2230
except gnutls.Error as error:
1488
except gnutls.errors.GNUTLSError as error:
2231
1489
logger.warning("Handshake failed: %s", error)
2232
1490
# Do not run session.bye() here: the session is not
2233
1491
# established. Just abandon the request.
2234
1492
return
2235
1493
logger.debug("Handshake succeeded")
2236
1494
2237
1495
approval_required = False
2238
1496
try:
2239
1497
try:
2240
fpr = self.fingerprint(
2241
self.peer_certificate(session))
2242
except (TypeError, gnutls.Error) as error:
1498
fpr = self.fingerprint(self.peer_certificate
1499
(session))
1500
except (TypeError,
1501
gnutls.errors.GNUTLSError) as error:
2243
1502
logger.warning("Bad certificate: %s", error)
2244
1503
return
2245
1504
logger.debug("Fingerprint: %s", fpr)
2246
1505
if self.server.use_dbus:
1506
# Emit D-Bus signal
1507
client.NewRequest(str(self.client_address))
1508
2247
1509
try:
2248
1510
client = ProxyClient(child_pipe, fpr,
2249
1511
self.client_address)
2250
1512
except KeyError:
2251
1513
return
2252
1514
2253
1515
if client.approval_delay:
2254
1516
delay = client.approval_delay
2255
1517
client.approvals_pending += 1
2256
1518
approval_required = True
2257
1519
2258
1520
while True:
2259
1521
if not client.enabled:
2260
1522
logger.info("Client %s is disabled",
2261
client.name)
1523
client.name)
2262
1524
if self.server.use_dbus:
2263
1525
# Emit D-Bus signal
2264
1526
client.Rejected("Disabled")
2265
1527
return
2266
2267
if client.approved or not client.approval_delay:
2268
# 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
2269
1531
break
2270
elif client.approved is None:
1532
elif client._approved is None:
2271
1533
logger.info("Client %s needs approval",
2272
1534
client.name)
2273
1535
if self.server.use_dbus:
2274
1536
# Emit D-Bus signal
2275
1537
client.NeedApproval(
2276
client.approval_delay.total_seconds()
2277
* 1000, client.approved_by_default)
1538
client.approval_delay_milliseconds(),
1539
client.approved_by_default)
2278
1540
else:
2279
1541
logger.warning("Client %s was not approved",
2280
1542
client.name)
2282
1544
# Emit D-Bus signal
2283
1545
client.Rejected("Denied")
2284
1546
return
2285
2286
# wait until timeout or approved
1547
1548
#wait until timeout or approved
2287
1549
time = datetime.datetime.now()
2288
1550
client.changedstate.acquire()
2289
client.changedstate.wait(delay.total_seconds())
1551
(client.changedstate.wait
1552
(float(client._timedelta_to_milliseconds(delay)
1553
/ 1000)))
2290
1554
client.changedstate.release()
2291
1555
time2 = datetime.datetime.now()
2292
1556
if (time2 - time) >= delay:
2302
1566
break
2303
1567
else:
2304
1568
delay -= time2 - time
2305
2306
try:
2307
session.send(client.secret)
2308
except gnutls.Error as error:
2309
logger.warning("gnutls send failed",
2310
exc_info=error)
2311
return
2312
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
2313
1582
logger.info("Sending secret to %s", client.name)
2314
1583
# bump the timeout using extended_timeout
2315
client.bump_timeout(client.extended_timeout)
1584
client.checked_ok(client.extended_timeout)
2316
1585
if self.server.use_dbus:
2317
1586
# Emit D-Bus signal
2318
1587
client.GotSecret()
2319
1588
2320
1589
finally:
2321
1590
if approval_required:
2322
1591
client.approvals_pending -= 1
2323
1592
try:
2324
1593
session.bye()
2325
except gnutls.Error as error:
2326
logger.warning("GnuTLS bye failed",
2327
exc_info=error)
2328
1594
except gnutls.errors.GNUTLSError as error:
1595
logger.warning("GnuTLS bye failed")
1596
2329
1597
@staticmethod
2330
1598
def peer_certificate(session):
2331
1599
"Return the peer's OpenPGP certificate as a bytestring"
2332
1600
# If not an OpenPGP certificate...
2333
if (gnutls.certificate_type_get(session._c_object)
2334
!= gnutls.CRT_OPENPGP):
2335
# ...return invalid data
2336
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
2337
1606
list_size = ctypes.c_uint(1)
2338
cert_list = (gnutls.certificate_get_peers
1607
cert_list = (gnutls.library.functions
1608
.gnutls_certificate_get_peers
2339
1609
(session._c_object, ctypes.byref(list_size)))
2340
1610
if not bool(cert_list) and list_size.value != 0:
2341
raise gnutls.Error("error getting peer certificate")
1611
raise gnutls.errors.GNUTLSError("error getting peer"
1612
" certificate")
2342
1613
if list_size.value == 0:
2343
1614
return None
2344
1615
cert = cert_list[0]
2345
1616
return ctypes.string_at(cert.data, cert.size)
2346
1617
2347
1618
@staticmethod
2348
1619
def fingerprint(openpgp):
2349
1620
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2350
1621
# New GnuTLS "datum" with the OpenPGP public key
2351
datum = gnutls.datum_t(
2352
ctypes.cast(ctypes.c_char_p(openpgp),
2353
ctypes.POINTER(ctypes.c_ubyte)),
2354
ctypes.c_uint(len(openpgp)))
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))))
2355
1627
# New empty GnuTLS certificate
2356
crt = gnutls.openpgp_crt_t()
2357
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)))
2358
1631
# Import the OpenPGP public key into the certificate
2359
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2360
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))
2361
1636
# Verify the self signature in the key
2362
1637
crtverify = ctypes.c_uint()
2363
gnutls.openpgp_crt_verify_self(crt, 0,
2364
ctypes.byref(crtverify))
1638
(gnutls.library.functions
1639
.gnutls_openpgp_crt_verify_self(crt, 0,
1640
ctypes.byref(crtverify)))
2365
1641
if crtverify.value != 0:
2366
gnutls.openpgp_crt_deinit(crt)
2367
raise gnutls.CertificateSecurityError("Verify failed")
1642
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1643
raise (gnutls.errors.CertificateSecurityError
1644
("Verify failed"))
2368
1645
# New buffer for the fingerprint
2369
1646
buf = ctypes.create_string_buffer(20)
2370
1647
buf_len = ctypes.c_size_t()
2371
1648
# Get the fingerprint from the certificate into the buffer
2372
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2373
ctypes.byref(buf_len))
1649
(gnutls.library.functions
1650
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1651
ctypes.byref(buf_len)))
2374
1652
# Deinit the certificate
2375
gnutls.openpgp_crt_deinit(crt)
1653
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2376
1654
# Convert the buffer to a Python bytestring
2377
1655
fpr = ctypes.string_at(buf, buf_len.value)
2378
1656
# Convert the bytestring to hexadecimal notation
2382
1660
2383
1661
class MultiprocessingMixIn(object):
2384
1662
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2385
2386
1663
def sub_process_main(self, request, address):
2387
1664
try:
2388
1665
self.finish_request(request, address)
2389
except Exception:
1666
except:
2390
1667
self.handle_error(request, address)
2391
1668
self.close_request(request)
2392
1669
2393
1670
def process_request(self, request, address):
2394
1671
"""Start a new process to process the request."""
2395
proc = multiprocessing.Process(target=self.sub_process_main,
2396
args=(request, address))
1672
proc = multiprocessing.Process(target = self.sub_process_main,
1673
args = (request,
1674
address))
2397
1675
proc.start()
2398
1676
return proc
2399
1677
2400
1678
2401
1679
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2402
1680
""" adds a pipe to the MixIn """
2403
2404
1681
def process_request(self, request, client_address):
2405
1682
"""Overrides and wraps the original process_request().
2406
1683
2407
1684
This function creates a new pipe in self.pipe
2408
1685
"""
2409
1686
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2410
1687
2411
1688
proc = MultiprocessingMixIn.process_request(self, request,
2412
1689
client_address)
2413
1690
self.child_pipe.close()
2414
1691
self.add_pipe(parent_pipe, proc)
2415
1692
2416
1693
def add_pipe(self, parent_pipe, proc):
2417
1694
"""Dummy function; override as necessary"""
2418
raise NotImplementedError()
1695
raise NotImplementedError
2419
1696
2420
1697
2421
1698
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2422
1699
socketserver.TCPServer, object):
2423
1700
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2424
1701
2425
1702
Attributes:
2426
1703
enabled: Boolean; whether this server is activated yet
2427
1704
interface: None or a network interface name (string)
2428
1705
use_ipv6: Boolean; to use IPv6 or not
2429
1706
"""
2430
2431
1707
def __init__(self, server_address, RequestHandlerClass,
2432
interface=None,
2433
use_ipv6=True,
2434
socketfd=None):
2435
"""If socketfd is set, use that file descriptor instead of
2436
creating a new one with socket.socket().
2437
"""
1708
interface=None, use_ipv6=True):
2438
1709
self.interface = interface
2439
1710
if use_ipv6:
2440
1711
self.address_family = socket.AF_INET6
2441
if socketfd is not None:
2442
# Save the file descriptor
2443
self.socketfd = socketfd
2444
# Save the original socket.socket() function
2445
self.socket_socket = socket.socket
2446
2447
# To implement --socket, we monkey patch socket.socket.
2448
#
2449
# (When socketserver.TCPServer is a new-style class, we
2450
# could make self.socket into a property instead of monkey
2451
# patching socket.socket.)
2452
#
2453
# Create a one-time-only replacement for socket.socket()
2454
@functools.wraps(socket.socket)
2455
def socket_wrapper(*args, **kwargs):
2456
# Restore original function so subsequent calls are
2457
# not affected.
2458
socket.socket = self.socket_socket
2459
del self.socket_socket
2460
# This time only, return a new socket object from the
2461
# saved file descriptor.
2462
return socket.fromfd(self.socketfd, *args, **kwargs)
2463
# Replace socket.socket() function with wrapper
2464
socket.socket = socket_wrapper
2465
# The socketserver.TCPServer.__init__ will call
2466
# socket.socket(), which might be our replacement,
2467
# socket_wrapper(), if socketfd was set.
2468
1712
socketserver.TCPServer.__init__(self, server_address,
2469
1713
RequestHandlerClass)
2470
2471
1714
def server_bind(self):
2472
1715
"""This overrides the normal server_bind() function
2473
1716
to bind to an interface if one was specified, and also NOT to
2474
1717
bind to an address or port if they were not specified."""
2475
global SO_BINDTODEVICE
2476
1718
if self.interface is not None:
2477
1719
if SO_BINDTODEVICE is None:
2478
# Fall back to a hard-coded value which seems to be
2479
# common enough.
2480
logger.warning("SO_BINDTODEVICE not found, trying 25")
2481
SO_BINDTODEVICE = 25
2482
try:
2483
self.socket.setsockopt(
2484
socket.SOL_SOCKET, SO_BINDTODEVICE,
2485
(self.interface + "\0").encode("utf-8"))
2486
except socket.error as error:
2487
if error.errno == errno.EPERM:
2488
logger.error("No permission to bind to"
2489
" interface %s", self.interface)
2490
elif error.errno == errno.ENOPROTOOPT:
2491
logger.error("SO_BINDTODEVICE not available;"
2492
" cannot bind to interface %s",
2493
self.interface)
2494
elif error.errno == errno.ENODEV:
2495
logger.error("Interface %s does not exist,"
2496
" cannot bind", self.interface)
2497
else:
2498
raise
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
2499
1740
# Only bind(2) the socket if we really need to.
2500
1741
if self.server_address[0] or self.server_address[1]:
2501
1742
if not self.server_address[0]:
2502
1743
if self.address_family == socket.AF_INET6:
2503
any_address = "::" # in6addr_any
1744
any_address = "::" # in6addr_any
2504
1745
else:
2505
any_address = "0.0.0.0" # INADDR_ANY
1746
any_address = socket.INADDR_ANY
2506
1747
self.server_address = (any_address,
2507
1748
self.server_address[1])
2508
1749
elif not self.server_address[1]:
2509
self.server_address = (self.server_address[0], 0)
1750
self.server_address = (self.server_address[0],
1751
0)
2510
1752
# if self.interface:
2511
1753
# self.server_address = (self.server_address[0],
2512
1754
# 0, # port
2518
1760
2519
1761
class MandosServer(IPv6_TCPServer):
2520
1762
"""Mandos server.
2521
1763
2522
1764
Attributes:
2523
1765
clients: set of Client objects
2524
1766
gnutls_priority GnuTLS priority string
2525
1767
use_dbus: Boolean; to emit D-Bus signals or not
2526
2527
Assumes a GLib.MainLoop event loop.
1768
1769
Assumes a gobject.MainLoop event loop.
2528
1770
"""
2529
2530
1771
def __init__(self, server_address, RequestHandlerClass,
2531
interface=None,
2532
use_ipv6=True,
2533
clients=None,
2534
gnutls_priority=None,
2535
use_dbus=True,
2536
socketfd=None):
1772
interface=None, use_ipv6=True, clients=None,
1773
gnutls_priority=None, use_dbus=True):
2537
1774
self.enabled = False
2538
1775
self.clients = clients
2539
1776
if self.clients is None:
2542
1779
self.gnutls_priority = gnutls_priority
2543
1780
IPv6_TCPServer.__init__(self, server_address,
2544
1781
RequestHandlerClass,
2545
interface=interface,
2546
use_ipv6=use_ipv6,
2547
socketfd=socketfd)
2548
1782
interface = interface,
1783
use_ipv6 = use_ipv6)
2549
1784
def server_activate(self):
2550
1785
if self.enabled:
2551
1786
return socketserver.TCPServer.server_activate(self)
2552
1787
2553
1788
def enable(self):
2554
1789
self.enabled = True
2555
1790
2556
1791
def add_pipe(self, parent_pipe, proc):
2557
1792
# Call "handle_ipc" for both data and EOF events
2558
GLib.io_add_watch(
2559
parent_pipe.fileno(),
2560
GLib.IO_IN | GLib.IO_HUP,
2561
functools.partial(self.handle_ipc,
2562
parent_pipe=parent_pipe,
2563
proc=proc))
2564
2565
def handle_ipc(self, source, condition,
2566
parent_pipe=None,
2567
proc=None,
2568
client_object=None):
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)
2569
1816
# error, or the other end of multiprocessing.Pipe has closed
2570
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1817
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2571
1818
# Wait for other process to exit
2572
1819
proc.join()
2573
1820
return False
2574
1821
2575
1822
# Read a request from the child
2576
1823
request = parent_pipe.recv()
2577
1824
command = request[0]
2578
1825
2579
1826
if command == 'init':
2580
1827
fpr = request[1]
2581
1828
address = request[2]
2582
2583
for c in self.clients.values():
1829
1830
for c in self.clients.itervalues():
2584
1831
if c.fingerprint == fpr:
2585
1832
client = c
2586
1833
break
2593
1840
address[0])
2594
1841
parent_pipe.send(False)
2595
1842
return False
2596
2597
GLib.io_add_watch(
2598
parent_pipe.fileno(),
2599
GLib.IO_IN | GLib.IO_HUP,
2600
functools.partial(self.handle_ipc,
2601
parent_pipe=parent_pipe,
2602
proc=proc,
2603
client_object=client))
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))
2604
1852
parent_pipe.send(True)
2605
1853
# remove the old hook in favor of the new above hook on
2606
1854
# same fileno
2609
1857
funcname = request[1]
2610
1858
args = request[2]
2611
1859
kwargs = request[3]
2612
1860
2613
1861
parent_pipe.send(('data', getattr(client_object,
2614
1862
funcname)(*args,
2615
**kwargs)))
2616
1863
**kwargs)))
1864
2617
1865
if command == 'getattr':
2618
1866
attrname = request[1]
2619
if isinstance(client_object.__getattribute__(attrname),
2620
collections.Callable):
2621
parent_pipe.send(('function', ))
1867
if callable(client_object.__getattribute__(attrname)):
1868
parent_pipe.send(('function',))
2622
1869
else:
2623
parent_pipe.send((
2624
'data', client_object.__getattribute__(attrname)))
2625
1870
parent_pipe.send(('data', client_object
1871
.__getattribute__(attrname)))
1872
2626
1873
if command == 'setattr':
2627
1874
attrname = request[1]
2628
1875
value = request[2]
2629
1876
setattr(client_object, attrname, value)
2630
1877
2631
1878
return True
2632
1879
2633
1880
2634
def rfc3339_duration_to_delta(duration):
2635
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2636
2637
>>> rfc3339_duration_to_delta("P7D")
2638
datetime.timedelta(7)
2639
>>> rfc3339_duration_to_delta("PT60S")
2640
datetime.timedelta(0, 60)
2641
>>> rfc3339_duration_to_delta("PT60M")
2642
datetime.timedelta(0, 3600)
2643
>>> rfc3339_duration_to_delta("PT24H")
2644
datetime.timedelta(1)
2645
>>> rfc3339_duration_to_delta("P1W")
2646
datetime.timedelta(7)
2647
>>> rfc3339_duration_to_delta("PT5M30S")
2648
datetime.timedelta(0, 330)
2649
>>> rfc3339_duration_to_delta("P1DT3M20S")
2650
datetime.timedelta(1, 200)
2651
"""
2652
2653
# Parsing an RFC 3339 duration with regular expressions is not
2654
# possible - there would have to be multiple places for the same
2655
# values, like seconds. The current code, while more esoteric, is
2656
# cleaner without depending on a parsing library. If Python had a
2657
# built-in library for parsing we would use it, but we'd like to
2658
# avoid excessive use of external libraries.
2659
2660
# New type for defining tokens, syntax, and semantics all-in-one
2661
Token = collections.namedtuple("Token", (
2662
"regexp", # To match token; if "value" is not None, must have
2663
# a "group" containing digits
2664
"value", # datetime.timedelta or None
2665
"followers")) # Tokens valid after this token
2666
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2667
# the "duration" ABNF definition in RFC 3339, Appendix A.
2668
token_end = Token(re.compile(r"$"), None, frozenset())
2669
token_second = Token(re.compile(r"(\d+)S"),
2670
datetime.timedelta(seconds=1),
2671
frozenset((token_end, )))
2672
token_minute = Token(re.compile(r"(\d+)M"),
2673
datetime.timedelta(minutes=1),
2674
frozenset((token_second, token_end)))
2675
token_hour = Token(re.compile(r"(\d+)H"),
2676
datetime.timedelta(hours=1),
2677
frozenset((token_minute, token_end)))
2678
token_time = Token(re.compile(r"T"),
2679
None,
2680
frozenset((token_hour, token_minute,
2681
token_second)))
2682
token_day = Token(re.compile(r"(\d+)D"),
2683
datetime.timedelta(days=1),
2684
frozenset((token_time, token_end)))
2685
token_month = Token(re.compile(r"(\d+)M"),
2686
datetime.timedelta(weeks=4),
2687
frozenset((token_day, token_end)))
2688
token_year = Token(re.compile(r"(\d+)Y"),
2689
datetime.timedelta(weeks=52),
2690
frozenset((token_month, token_end)))
2691
token_week = Token(re.compile(r"(\d+)W"),
2692
datetime.timedelta(weeks=1),
2693
frozenset((token_end, )))
2694
token_duration = Token(re.compile(r"P"), None,
2695
frozenset((token_year, token_month,
2696
token_day, token_time,
2697
token_week)))
2698
# Define starting values:
2699
# Value so far
2700
value = datetime.timedelta()
2701
found_token = None
2702
# Following valid tokens
2703
followers = frozenset((token_duration, ))
2704
# String left to parse
2705
s = duration
2706
# Loop until end token is found
2707
while found_token is not token_end:
2708
# Search for any currently valid tokens
2709
for token in followers:
2710
match = token.regexp.match(s)
2711
if match is not None:
2712
# Token found
2713
if token.value is not None:
2714
# Value found, parse digits
2715
factor = int(match.group(1), 10)
2716
# Add to value so far
2717
value += factor * token.value
2718
# Strip token from string
2719
s = token.regexp.sub("", s, 1)
2720
# Go to found token
2721
found_token = token
2722
# Set valid next tokens
2723
followers = found_token.followers
2724
break
2725
else:
2726
# No currently valid tokens were found
2727
raise ValueError("Invalid RFC 3339 duration: {!r}"
2728
.format(duration))
2729
# End token found
2730
return value
2731
2732
2733
1881
def string_to_delta(interval):
2734
1882
"""Parse a string and return a datetime.timedelta
2735
1883
2736
1884
>>> string_to_delta('7d')
2737
1885
datetime.timedelta(7)
2738
1886
>>> string_to_delta('60s')
2746
1894
>>> string_to_delta('5m 30s')
2747
1895
datetime.timedelta(0, 330)
2748
1896
"""
2749
2750
try:
2751
return rfc3339_duration_to_delta(interval)
2752
except ValueError:
2753
pass
2754
2755
1897
timevalue = datetime.timedelta(0)
2756
1898
for s in interval.split():
2757
1899
try:
2758
suffix = s[-1]
1900
suffix = unicode(s[-1])
2759
1901
value = int(s[:-1])
2760
1902
if suffix == "d":
2761
1903
delta = datetime.timedelta(value)
2768
1910
elif suffix == "w":
2769
1911
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2770
1912
else:
2771
raise ValueError("Unknown suffix {!r}".format(suffix))
2772
except IndexError as e:
1913
raise ValueError("Unknown suffix %r" % suffix)
1914
except (ValueError, IndexError) as e:
2773
1915
raise ValueError(*(e.args))
2774
1916
timevalue += delta
2775
1917
return timevalue
2776
1918
2777
1919
2778
def daemon(nochdir=False, noclose=False):
1920
def daemon(nochdir = False, noclose = False):
2779
1921
"""See daemon(3). Standard BSD Unix function.
2780
1922
2781
1923
This should really exist as os.daemon, but it doesn't (yet)."""
2782
1924
if os.fork():
2783
1925
sys.exit()
2788
1930
sys.exit()
2789
1931
if not noclose:
2790
1932
# Close all standard open file descriptors
2791
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1933
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2792
1934
if not stat.S_ISCHR(os.fstat(null).st_mode):
2793
1935
raise OSError(errno.ENODEV,
2794
"{} not a character device"
2795
.format(os.devnull))
1936
"%s not a character device"
1937
% os.path.devnull)
2796
1938
os.dup2(null, sys.stdin.fileno())
2797
1939
os.dup2(null, sys.stdout.fileno())
2798
1940
os.dup2(null, sys.stderr.fileno())
2801
1943
2802
1944
2803
1945
def main():
2804
1946
2805
1947
##################################################################
2806
1948
# Parsing of options, both command line and config file
2807
1949
2808
1950
parser = argparse.ArgumentParser()
2809
1951
parser.add_argument("-v", "--version", action="version",
2810
version="%(prog)s {}".format(version),
1952
version = "%%(prog)s %s" % version,
2811
1953
help="show version number and exit")
2812
1954
parser.add_argument("-i", "--interface", metavar="IF",
2813
1955
help="Bind to interface IF")
2819
1961
help="Run self-test")
2820
1962
parser.add_argument("--debug", action="store_true",
2821
1963
help="Debug mode; run in foreground and log"
2822
" to terminal", default=None)
1964
" to terminal")
2823
1965
parser.add_argument("--debuglevel", metavar="LEVEL",
2824
1966
help="Debug level for stdout output")
2825
1967
parser.add_argument("--priority", help="GnuTLS"
2832
1974
" files")
2833
1975
parser.add_argument("--no-dbus", action="store_false",
2834
1976
dest="use_dbus", help="Do not provide D-Bus"
2835
" system bus interface", default=None)
1977
" system bus interface")
2836
1978
parser.add_argument("--no-ipv6", action="store_false",
2837
dest="use_ipv6", help="Do not use IPv6",
2838
default=None)
1979
dest="use_ipv6", help="Do not use IPv6")
2839
1980
parser.add_argument("--no-restore", action="store_false",
2840
1981
dest="restore", help="Do not restore stored"
2841
" state", default=None)
2842
parser.add_argument("--socket", type=int,
2843
help="Specify a file descriptor to a network"
2844
" socket to use instead of creating one")
1982
" state")
2845
1983
parser.add_argument("--statedir", metavar="DIR",
2846
1984
help="Directory to save/restore state in")
2847
parser.add_argument("--foreground", action="store_true",
2848
help="Run in foreground", default=None)
2849
parser.add_argument("--no-zeroconf", action="store_false",
2850
dest="zeroconf", help="Do not use Zeroconf",
2851
default=None)
2852
1985
2853
1986
options = parser.parse_args()
2854
1987
2855
1988
if options.check:
2856
1989
import doctest
2857
fail_count, test_count = doctest.testmod()
2858
sys.exit(os.EX_OK if fail_count == 0 else 1)
2859
1990
doctest.testmod()
1991
sys.exit()
1992
2860
1993
# Default values for config file for server-global settings
2861
server_defaults = {"interface": "",
2862
"address": "",
2863
"port": "",
2864
"debug": "False",
2865
"priority":
2866
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2867
":+SIGN-DSA-SHA256",
2868
"servicename": "Mandos",
2869
"use_dbus": "True",
2870
"use_ipv6": "True",
2871
"debuglevel": "",
2872
"restore": "True",
2873
"socket": "",
2874
"statedir": "/var/lib/mandos",
2875
"foreground": "False",
2876
"zeroconf": "True",
2877
}
2878
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
2879
2008
# Parse config file for server-global settings
2880
2009
server_config = configparser.SafeConfigParser(server_defaults)
2881
2010
del server_defaults
2882
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2011
server_config.read(os.path.join(options.configdir,
2012
"mandos.conf"))
2883
2013
# Convert the SafeConfigParser object to a dict
2884
2014
server_settings = server_config.defaults()
2885
2015
# Use the appropriate methods on the non-string config options
2886
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2887
"foreground", "zeroconf"):
2016
for option in ("debug", "use_dbus", "use_ipv6"):
2888
2017
server_settings[option] = server_config.getboolean("DEFAULT",
2889
2018
option)
2890
2019
if server_settings["port"]:
2891
2020
server_settings["port"] = server_config.getint("DEFAULT",
2892
2021
"port")
2893
if server_settings["socket"]:
2894
server_settings["socket"] = server_config.getint("DEFAULT",
2895
"socket")
2896
# Later, stdin will, and stdout and stderr might, be dup'ed
2897
# over with an opened os.devnull. But we don't want this to
2898
# happen with a supplied network socket.
2899
if 0 <= server_settings["socket"] <= 2:
2900
server_settings["socket"] = os.dup(server_settings
2901
["socket"])
2902
2022
del server_config
2903
2023
2904
2024
# Override the settings from the config file with command line
2905
2025
# options, if set.
2906
2026
for option in ("interface", "address", "port", "debug",
2907
"priority", "servicename", "configdir", "use_dbus",
2908
"use_ipv6", "debuglevel", "restore", "statedir",
2909
"socket", "foreground", "zeroconf"):
2027
"priority", "servicename", "configdir",
2028
"use_dbus", "use_ipv6", "debuglevel", "restore",
2029
"statedir"):
2910
2030
value = getattr(options, option)
2911
2031
if value is not None:
2912
2032
server_settings[option] = value
2913
2033
del options
2914
2034
# Force all strings to be unicode
2915
2035
for option in server_settings.keys():
2916
if isinstance(server_settings[option], bytes):
2917
server_settings[option] = (server_settings[option]
2918
.decode("utf-8"))
2919
# Force all boolean options to be boolean
2920
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2921
"foreground", "zeroconf"):
2922
server_settings[option] = bool(server_settings[option])
2923
# Debug implies foreground
2924
if server_settings["debug"]:
2925
server_settings["foreground"] = True
2036
if type(server_settings[option]) is str:
2037
server_settings[option] = unicode(server_settings[option])
2926
2038
# Now we have our good server settings in "server_settings"
2927
2039
2928
2040
##################################################################
2929
2930
if (not server_settings["zeroconf"]
2931
and not (server_settings["port"]
2932
or server_settings["socket"] != "")):
2933
parser.error("Needs port or socket to work without Zeroconf")
2934
2041
2935
2042
# For convenience
2936
2043
debug = server_settings["debug"]
2937
2044
debuglevel = server_settings["debuglevel"]
2939
2046
use_ipv6 = server_settings["use_ipv6"]
2940
2047
stored_state_path = os.path.join(server_settings["statedir"],
2941
2048
stored_state_file)
2942
foreground = server_settings["foreground"]
2943
zeroconf = server_settings["zeroconf"]
2944
2049
2945
2050
if debug:
2946
initlogger(debug, logging.DEBUG)
2051
initlogger(logging.DEBUG)
2947
2052
else:
2948
2053
if not debuglevel:
2949
initlogger(debug)
2054
initlogger()
2950
2055
else:
2951
2056
level = getattr(logging, debuglevel.upper())
2952
initlogger(debug, level)
2953
2057
initlogger(level)
2058
2954
2059
if server_settings["servicename"] != "Mandos":
2955
syslogger.setFormatter(
2956
logging.Formatter('Mandos ({}) [%(process)d]:'
2957
' %(levelname)s: %(message)s'.format(
2958
server_settings["servicename"])))
2959
2060
syslogger.setFormatter(logging.Formatter
2061
('Mandos (%s) [%%(process)d]:'
2062
' %%(levelname)s: %%(message)s'
2063
% server_settings["servicename"]))
2064
2960
2065
# Parse config file with clients
2961
client_config = configparser.SafeConfigParser(Client
2962
.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)
2963
2075
client_config.read(os.path.join(server_settings["configdir"],
2964
2076
"clients.conf"))
2965
2077
2966
2078
global mandos_dbus_service
2967
2079
mandos_dbus_service = None
2968
2969
socketfd = None
2970
if server_settings["socket"] != "":
2971
socketfd = server_settings["socket"]
2972
tcp_server = MandosServer(
2973
(server_settings["address"], server_settings["port"]),
2974
ClientHandler,
2975
interface=(server_settings["interface"] or None),
2976
use_ipv6=use_ipv6,
2977
gnutls_priority=server_settings["priority"],
2978
use_dbus=use_dbus,
2979
socketfd=socketfd)
2980
if not foreground:
2981
pidfilename = "/run/mandos.pid"
2982
if not os.path.isdir("/run/."):
2983
pidfilename = "/var/run/mandos.pid"
2984
pidfile = None
2985
try:
2986
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2987
except IOError as e:
2988
logger.error("Could not open file %r", pidfilename,
2989
exc_info=e)
2990
2991
for name, group in (("_mandos", "_mandos"),
2992
("mandos", "mandos"),
2993
("nobody", "nogroup")):
2994
try:
2995
uid = pwd.getpwnam(name).pw_uid
2996
gid = pwd.getpwnam(group).pw_gid
2997
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
2998
2104
except KeyError:
2999
continue
3000
else:
3001
uid = 65534
3002
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
3003
2111
try:
3004
2112
os.setgid(gid)
3005
2113
os.setuid(uid)
3006
if debug:
3007
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3008
gid))
3009
2114
except OSError as error:
3010
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3011
.format(uid, gid, os.strerror(error.errno)))
3012
if error.errno != errno.EPERM:
3013
raise
3014
2115
if error[0] != errno.EPERM:
2116
raise error
2117
3015
2118
if debug:
3016
2119
# Enable all possible GnuTLS debugging
3017
2120
3018
2121
# "Use a log level over 10 to enable all debugging options."
3019
2122
# - GnuTLS manual
3020
gnutls.global_set_log_level(11)
3021
3022
@gnutls.log_func
2123
gnutls.library.functions.gnutls_global_set_log_level(11)
2124
2125
@gnutls.library.types.gnutls_log_func
3023
2126
def debug_gnutls(level, string):
3024
2127
logger.debug("GnuTLS: %s", string[:-1])
3025
3026
gnutls.global_set_log_function(debug_gnutls)
3027
2128
2129
(gnutls.library.functions
2130
.gnutls_global_set_log_function(debug_gnutls))
2131
3028
2132
# Redirect stdin so all checkers get /dev/null
3029
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2133
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3030
2134
os.dup2(null, sys.stdin.fileno())
3031
2135
if null > 2:
3032
2136
os.close(null)
3033
2137
else:
2138
# No console logging
2139
logger.removeHandler(console)
2140
3034
2141
# Need to fork before connecting to D-Bus
3035
if not foreground:
2142
if not debug:
3036
2143
# Close all input and output, do double fork, etc.
3037
2144
daemon()
3038
3039
# multiprocessing will use threads, so before we use GLib we need
3040
# to inform GLib that threads will be used.
3041
GLib.threads_init()
3042
2145
3043
2146
global main_loop
3044
2147
# From the Avahi example code
3045
DBusGMainLoop(set_as_default=True)
3046
main_loop = GLib.MainLoop()
2148
DBusGMainLoop(set_as_default=True )
2149
main_loop = gobject.MainLoop()
3047
2150
bus = dbus.SystemBus()
3048
2151
# End of Avahi example code
3049
2152
if use_dbus:
3050
2153
try:
3051
2154
bus_name = dbus.service.BusName("se.recompile.Mandos",
3052
bus,
3053
do_not_queue=True)
3054
old_bus_name = dbus.service.BusName(
3055
"se.bsnet.fukt.Mandos", bus,
3056
do_not_queue=True)
3057
except dbus.exceptions.DBusException as e:
3058
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")
3059
2161
use_dbus = False
3060
2162
server_settings["use_dbus"] = False
3061
2163
tcp_server.use_dbus = False
3062
if zeroconf:
3063
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3064
service = AvahiServiceToSyslog(
3065
name=server_settings["servicename"],
3066
servicetype="_mandos._tcp",
3067
protocol=protocol,
3068
bus=bus)
3069
if server_settings["interface"]:
3070
service.interface = if_nametoindex(
3071
server_settings["interface"].encode("utf-8"))
3072
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
3073
2173
global multiprocessing_manager
3074
2174
multiprocessing_manager = multiprocessing.Manager()
3075
2175
3076
2176
client_class = Client
3077
2177
if use_dbus:
3078
client_class = functools.partial(ClientDBus, bus=bus)
3079
3080
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
3081
2204
old_client_settings = {}
3082
clients_data = {}
3083
3084
# This is used to redirect stdout and stderr for checker processes
3085
global wnull
3086
wnull = open(os.devnull, "w") # A writable /dev/null
3087
# Only used if server is running in foreground but not in debug
3088
# mode
3089
if debug or not foreground:
3090
wnull.close()
3091
2205
clients_data = []
2206
3092
2207
# Get client data and settings from last running state.
3093
2208
if server_settings["restore"]:
3094
2209
try:
3095
2210
with open(stored_state_path, "rb") as stored_state:
3096
if sys.version_info.major == 2:
3097
clients_data, old_client_settings = pickle.load(
3098
stored_state)
3099
else:
3100
bytes_clients_data, bytes_old_client_settings = (
3101
pickle.load(stored_state, encoding="bytes"))
3102
# Fix bytes to strings
3103
# clients_data
3104
# .keys()
3105
clients_data = {(key.decode("utf-8")
3106
if isinstance(key, bytes)
3107
else key): value
3108
for key, value in
3109
bytes_clients_data.items()}
3110
del bytes_clients_data
3111
for key in clients_data:
3112
value = {(k.decode("utf-8")
3113
if isinstance(k, bytes) else k): v
3114
for k, v in
3115
clients_data[key].items()}
3116
clients_data[key] = value
3117
# .client_structure
3118
value["client_structure"] = [
3119
(s.decode("utf-8")
3120
if isinstance(s, bytes)
3121
else s) for s in
3122
value["client_structure"]]
3123
# .name & .host
3124
for k in ("name", "host"):
3125
if isinstance(value[k], bytes):
3126
value[k] = value[k].decode("utf-8")
3127
# old_client_settings
3128
# .keys()
3129
old_client_settings = {
3130
(key.decode("utf-8")
3131
if isinstance(key, bytes)
3132
else key): value
3133
for key, value in
3134
bytes_old_client_settings.items()}
3135
del bytes_old_client_settings
3136
# .host
3137
for value in old_client_settings.values():
3138
if isinstance(value["host"], bytes):
3139
value["host"] = (value["host"]
3140
.decode("utf-8"))
2211
clients_data, old_client_settings = (pickle.load
2212
(stored_state))
3141
2213
os.remove(stored_state_path)
3142
2214
except IOError as e:
3143
if e.errno == errno.ENOENT:
3144
logger.warning("Could not load persistent state:"
3145
" {}".format(os.strerror(e.errno)))
3146
else:
3147
logger.critical("Could not load persistent state:",
3148
exc_info=e)
2215
logger.warning("Could not load persistent state: {0}"
2216
.format(e))
2217
if e.errno != errno.ENOENT:
3149
2218
raise
3150
except EOFError as e:
3151
logger.warning("Could not load persistent state: "
3152
"EOFError:",
3153
exc_info=e)
3154
3155
with PGPEngine() as pgp:
3156
for client_name, client in clients_data.items():
3157
# Skip removed clients
3158
if client_name not in client_settings:
3159
continue
3160
2219
2220
with Crypto() as crypt:
2221
for client in clients_data:
2222
client_name = client["name"]
2223
3161
2224
# Decide which value to use after restoring saved state.
3162
2225
# We have three different values: Old config file,
3163
2226
# new config file, and saved state.
3168
2231
# For each value in new config, check if it
3169
2232
# differs from the old config value (Except for
3170
2233
# the "secret" attribute)
3171
if (name != "secret"
3172
and (value !=
3173
old_client_settings[client_name][name])):
3174
client[name] = value
2234
if (name != "secret" and
2235
value != old_client_settings[client_name]
2236
[name]):
2237
setattr(client, name, value)
3175
2238
except KeyError:
3176
2239
pass
3177
2240
3178
2241
# Clients who has passed its expire date can still be
3179
# enabled if its last checker was successful. A Client
3180
# whose checker succeeded before we stored its state is
3181
# assumed to have successfully run all checkers during
3182
# downtime.
3183
if client["enabled"]:
3184
if datetime.datetime.utcnow() >= client["expires"]:
3185
if not client["last_checked_ok"]:
3186
logger.warning(
3187
"disabling client {} - Client never "
3188
"performed a successful checker".format(
3189
client_name))
3190
client["enabled"] = False
3191
elif client["last_checker_status"] != 0:
3192
logger.warning(
3193
"disabling client {} - Client last"
3194
" checker failed with error code"
3195
" {}".format(
3196
client_name,
3197
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:
3198
2250
client["enabled"] = False
3199
2251
else:
3200
client["expires"] = (
3201
datetime.datetime.utcnow()
3202
+ client["timeout"])
3203
logger.debug("Last checker succeeded,"
3204
" keeping {} enabled".format(
3205
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
3206
2284
try:
3207
client["secret"] = pgp.decrypt(
3208
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 = (
3209
2293
client_settings[client_name]["secret"])
3210
except PGPError:
3211
# If decryption fails, we use secret from new settings
3212
logger.debug("Failed to decrypt {} old secret".format(
3213
client_name))
3214
client["secret"] = (client_settings[client_name]
3215
["secret"])
3216
3217
# Add/remove clients based on new changes made to config
3218
for client_name in (set(old_client_settings)
3219
- set(client_settings)):
3220
del clients_data[client_name]
3221
for client_name in (set(client_settings)
3222
- set(old_client_settings)):
3223
clients_data[client_name] = client_settings[client_name]
3224
3225
# Create all client objects
3226
for client_name, client in clients_data.items():
3227
tcp_server.clients[client_name] = client_class(
3228
name=client_name,
3229
settings=client,
3230
server_settings=server_settings)
3231
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
3232
2305
if not tcp_server.clients:
3233
2306
logger.warning("No clients defined")
3234
3235
if not foreground:
3236
if pidfile is not None:
3237
pid = os.getpid()
3238
try:
3239
with pidfile:
3240
print(pid, file=pidfile)
3241
except IOError:
3242
logger.error("Could not write to file %r with PID %d",
3243
pidfilename, pid)
3244
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
3245
2320
del pidfilename
3246
3247
for termsig in (signal.SIGHUP, signal.SIGTERM):
3248
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3249
lambda: main_loop.quit() and False)
3250
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
3251
2327
if use_dbus:
3252
3253
@alternate_dbus_interfaces(
3254
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3255
class MandosDBusService(DBusObjectWithObjectManager):
2328
class MandosDBusService(dbus.service.Object):
3256
2329
"""A D-Bus proxy object"""
3257
3258
2330
def __init__(self):
3259
2331
dbus.service.Object.__init__(self, bus, "/")
3260
3261
2332
_interface = "se.recompile.Mandos"
3262
2333
3263
2334
@dbus.service.signal(_interface, signature="o")
3264
2335
def ClientAdded(self, objpath):
3265
2336
"D-Bus signal"
3266
2337
pass
3267
2338
3268
2339
@dbus.service.signal(_interface, signature="ss")
3269
2340
def ClientNotFound(self, fingerprint, address):
3270
2341
"D-Bus signal"
3271
2342
pass
3272
3273
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3274
"true"})
2343
3275
2344
@dbus.service.signal(_interface, signature="os")
3276
2345
def ClientRemoved(self, objpath, name):
3277
2346
"D-Bus signal"
3278
2347
pass
3279
3280
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3281
"true"})
2348
3282
2349
@dbus.service.method(_interface, out_signature="ao")
3283
2350
def GetAllClients(self):
3284
2351
"D-Bus method"
3285
return dbus.Array(c.dbus_object_path for c in
3286
tcp_server.clients.values())
3287
3288
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3289
"true"})
2352
return dbus.Array(c.dbus_object_path
2353
for c in
2354
tcp_server.clients.itervalues())
2355
3290
2356
@dbus.service.method(_interface,
3291
2357
out_signature="a{oa{sv}}")
3292
2358
def GetAllClientsWithProperties(self):
3293
2359
"D-Bus method"
3294
2360
return dbus.Dictionary(
3295
{c.dbus_object_path: c.GetAll(
3296
"se.recompile.Mandos.Client")
3297
for c in tcp_server.clients.values()},
2361
((c.dbus_object_path, c.GetAll(""))
2362
for c in tcp_server.clients.itervalues()),
3298
2363
signature="oa{sv}")
3299
2364
3300
2365
@dbus.service.method(_interface, in_signature="o")
3301
2366
def RemoveClient(self, object_path):
3302
2367
"D-Bus method"
3303
for c in tcp_server.clients.values():
2368
for c in tcp_server.clients.itervalues():
3304
2369
if c.dbus_object_path == object_path:
3305
2370
del tcp_server.clients[c.name]
3306
2371
c.remove_from_connection()
3307
# Don't signal the disabling
2372
# Don't signal anything except ClientRemoved
3308
2373
c.disable(quiet=True)
3309
# Emit D-Bus signal for removal
3310
self.client_removed_signal(c)
2374
# Emit D-Bus signal
2375
self.ClientRemoved(object_path, c.name)
3311
2376
return
3312
2377
raise KeyError(object_path)
3313
2378
3314
2379
del _interface
3315
3316
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3317
out_signature="a{oa{sa{sv}}}")
3318
def GetManagedObjects(self):
3319
"""D-Bus method"""
3320
return dbus.Dictionary(
3321
{client.dbus_object_path:
3322
dbus.Dictionary(
3323
{interface: client.GetAll(interface)
3324
for interface in
3325
client._get_all_interface_names()})
3326
for client in tcp_server.clients.values()})
3327
3328
def client_added_signal(self, client):
3329
"""Send the new standard signal and the old signal"""
3330
if use_dbus:
3331
# New standard signal
3332
self.InterfacesAdded(
3333
client.dbus_object_path,
3334
dbus.Dictionary(
3335
{interface: client.GetAll(interface)
3336
for interface in
3337
client._get_all_interface_names()}))
3338
# Old signal
3339
self.ClientAdded(client.dbus_object_path)
3340
3341
def client_removed_signal(self, client):
3342
"""Send the new standard signal and the old signal"""
3343
if use_dbus:
3344
# New standard signal
3345
self.InterfacesRemoved(
3346
client.dbus_object_path,
3347
client._get_all_interface_names())
3348
# Old signal
3349
self.ClientRemoved(client.dbus_object_path,
3350
client.name)
3351
3352
mandos_dbus_service = MandosDBusService()
3353
3354
# Save modules to variables to exempt the modules from being
3355
# unloaded before the function registered with atexit() is run.
3356
mp = multiprocessing
3357
wn = wnull
3358
2380
2381
class MandosDBusServiceTransitional(MandosDBusService):
2382
__metaclass__ = AlternateDBusNamesMetaclass
2383
mandos_dbus_service = MandosDBusServiceTransitional()
2384
3359
2385
def cleanup():
3360
2386
"Cleanup function; run on exit"
3361
if zeroconf:
3362
service.cleanup()
3363
3364
mp.active_children()
3365
wn.close()
2387
service.cleanup()
2388
2389
multiprocessing.active_children()
3366
2390
if not (tcp_server.clients or client_settings):
3367
2391
return
3368
2392
3369
2393
# Store client before exiting. Secrets are encrypted with key
3370
2394
# based on what config file has. If config file is
3371
2395
# removed/edited, old secret will thus be unrecovable.
3372
clients = {}
3373
with PGPEngine() as pgp:
3374
for client in tcp_server.clients.values():
2396
clients = []
2397
with Crypto() as crypt:
2398
for client in tcp_server.clients.itervalues():
3375
2399
key = client_settings[client.name]["secret"]
3376
client.encrypted_secret = pgp.encrypt(client.secret,
3377
key)
2400
client.encrypted_secret = crypt.encrypt(client.secret,
2401
key)
3378
2402
client_dict = {}
3379
3380
# A list of attributes that can not be pickled
3381
# + secret.
3382
exclude = {"bus", "changedstate", "secret",
3383
"checker", "server_settings"}
3384
for name, typ in inspect.getmembers(dbus.service
3385
.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)):
3386
2409
exclude.add(name)
3387
2410
3388
2411
client_dict["encrypted_secret"] = (client
3389
2412
.encrypted_secret)
3390
2413
for attr in client.client_structure:
3391
2414
if attr not in exclude:
3392
2415
client_dict[attr] = getattr(client, attr)
3393
3394
clients[client.name] = client_dict
2416
2417
clients.append(client_dict)
3395
2418
del client_settings[client.name]["secret"]
3396
2419
3397
2420
try:
3398
with tempfile.NamedTemporaryFile(
3399
mode='wb',
3400
suffix=".pickle",
3401
prefix='clients-',
3402
dir=os.path.dirname(stored_state_path),
3403
delete=False) as stored_state:
3404
pickle.dump((clients, client_settings), stored_state,
3405
protocol=2)
3406
tempname = stored_state.name
3407
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)
3408
2425
except (IOError, OSError) as e:
3409
if not debug:
3410
try:
3411
os.remove(tempname)
3412
except NameError:
3413
pass
3414
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3415
logger.warning("Could not save persistent state: {}"
3416
.format(os.strerror(e.errno)))
3417
else:
3418
logger.warning("Could not save persistent state:",
3419
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):
3420
2429
raise
3421
2430
3422
2431
# Delete all clients, and settings from config
3423
2432
while tcp_server.clients:
3424
2433
name, client = tcp_server.clients.popitem()
3425
2434
if use_dbus:
3426
2435
client.remove_from_connection()
3427
# Don't signal the disabling
2436
# Don't signal anything except ClientRemoved
3428
2437
client.disable(quiet=True)
3429
# Emit D-Bus signal for removal
3430
2438
if use_dbus:
3431
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)
3432
2443
client_settings.clear()
3433
2444
3434
2445
atexit.register(cleanup)
3435
3436
for client in tcp_server.clients.values():
2446
2447
for client in tcp_server.clients.itervalues():
3437
2448
if use_dbus:
3438
# Emit D-Bus signal for adding
3439
mandos_dbus_service.client_added_signal(client)
2449
# Emit D-Bus signal
2450
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3440
2451
# Need to initiate checking of clients
3441
2452
if client.enabled:
3442
2453
client.init_checker()
3443
2454
3444
2455
tcp_server.enable()
3445
2456
tcp_server.server_activate()
3446
2457
3447
2458
# Find out what port we got
3448
if zeroconf:
3449
service.port = tcp_server.socket.getsockname()[1]
2459
service.port = tcp_server.socket.getsockname()[1]
3450
2460
if use_ipv6:
3451
2461
logger.info("Now listening on address %r, port %d,"
3452
" flowinfo %d, scope_id %d",
3453
*tcp_server.socket.getsockname())
2462
" flowinfo %d, scope_id %d"
2463
% tcp_server.socket.getsockname())
3454
2464
else: # IPv4
3455
logger.info("Now listening on address %r, port %d",
3456
*tcp_server.socket.getsockname())
3457
3458
# service.interface = tcp_server.socket.getsockname()[3]
3459
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
3460
2470
try:
3461
if zeroconf:
3462
# From the Avahi example code
3463
try:
3464
service.activate()
3465
except dbus.exceptions.DBusException as error:
3466
logger.critical("D-Bus Exception", exc_info=error)
3467
cleanup()
3468
sys.exit(1)
3469
# End of Avahi example code
3470
3471
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3472
lambda *args, **kwargs:
3473
(tcp_server.handle_request
3474
(*args[2:], **kwargs) or True))
3475
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
3476
2485
logger.debug("Starting main loop")
3477
2486
main_loop.run()
3478
2487
except AvahiError as error:
3479
logger.critical("Avahi Error", exc_info=error)
2488
logger.critical("AvahiError: %s", error)
3480
2489
cleanup()
3481
2490
sys.exit(1)
3482
2491
except KeyboardInterrupt:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0