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 742
- compare with another revision
- download diff
- download tarball
- view history from revision 742
- Committer: Teddy Hogeborn
- Date: 2015-03-10 18:03:38 UTC
- Revision ID: teddy@recompile.se-20150310180338-pcxw6r2qmw9k6br9
Add ":!RSA" to GnuTLS priority string, to disallow non-DHE kx.
If Mandos was somehow made to use a non-ephemeral Diffie-Hellman key
exchange algorithm in the TLS handshake, any saved network traffic
could then be decrypted later if the Mandos client key was obtained.
By default, Mandos uses ephemeral DH key exchanges which does not have
this problem, but a non-ephemeral key exchange algorithm was still
enabled by default. The simplest solution is to simply turn that off,
which ensures that Mandos will always use ephemeral DH key exchanges.
There is a "PFS" priority string specifier, but we can't use it because:
1. Security-wise, it is a mix between "NORMAL" and "SECURE128" - it
enables a lot more algorithms than "SECURE256".
2. It is only available since GnuTLS 3.2.4.
Thanks to Andreas Fischer <af@bantuX.org> for reporting this issue.
If Mandos was somehow made to use a non-ephemeral Diffie-Hellman key
exchange algorithm in the TLS handshake, any saved network traffic
could then be decrypted later if the Mandos client key was obtained.
By default, Mandos uses ephemeral DH key exchanges which does not have
this problem, but a non-ephemeral key exchange algorithm was still
enabled by default. The simplest solution is to simply turn that off,
which ensures that Mandos will always use ephemeral DH key exchanges.
There is a "PFS" priority string specifier, but we can't use it because:
1. Security-wise, it is a mix between "NORMAL" and "SECURE128" - it
enables a lot more algorithms than "SECURE256".
2. It is only available since GnuTLS 3.2.4.
Thanks to Andreas Fischer <af@bantuX.org> for reporting this issue.
- files added:
- DBUS-API
- debian/source
- debian/upstream
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos
1
#!/usr/bin/python
1
#!/usr/bin/python2.7
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
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
# methods "add" and "remove" in the "AvahiService" class, the
10
# "server_state_changed" and "entry_group_state_changed" functions,
11
# and some lines in "main".
9
# methods "add", "remove", "server_state_changed",
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 Björn Påhlsson
14
# Copyright © 2008-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 Björn Påhlsson
16
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
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
#
31
# Contact the authors at <mandos@fukt.bsnet.se>.
31
# Contact the authors at <mandos@recompile.se>.
32
32
#
33
33
34
from __future__ import division, with_statement, absolute_import
35
36
import SocketServer
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
36
37
from future_builtins import *
38
39
import SocketServer as socketserver
37
40
import socket
38
import optparse
41
import argparse
39
42
import datetime
40
43
import errno
41
44
import gnutls.crypto
44
47
import gnutls.library.functions
45
48
import gnutls.library.constants
46
49
import gnutls.library.types
47
import ConfigParser
50
import ConfigParser as configparser
48
51
import sys
49
52
import re
50
53
import os
51
54
import signal
52
from sets import Set
53
55
import subprocess
54
56
import atexit
55
57
import stat
56
58
import logging
57
59
import logging.handlers
58
60
import pwd
59
from contextlib import closing
61
import contextlib
62
import struct
63
import fcntl
64
import functools
65
import cPickle as pickle
66
import multiprocessing
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
import collections
60
72
61
73
import dbus
62
74
import dbus.service
65
77
from dbus.mainloop.glib import DBusGMainLoop
66
78
import ctypes
67
79
import ctypes.util
80
import xml.dom.minidom
81
import inspect
68
82
69
83
try:
70
84
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
72
86
try:
73
87
from IN import SO_BINDTODEVICE
74
88
except ImportError:
75
# From /usr/include/asm/socket.h
76
SO_BINDTODEVICE = 25
77
78
79
version = "1.0.8"
80
81
logger = logging.Logger('mandos')
82
syslogger = (logging.handlers.SysLogHandler
83
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
84
address = "/dev/log"))
85
syslogger.setFormatter(logging.Formatter
86
('Mandos [%(process)d]: %(levelname)s:'
87
' %(message)s'))
88
logger.addHandler(syslogger)
89
90
console = logging.StreamHandler()
91
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
92
' %(levelname)s: %(message)s'))
93
logger.addHandler(console)
89
SO_BINDTODEVICE = None
90
91
if sys.version_info.major == 2:
92
str = unicode
93
94
version = "1.6.9"
95
stored_state_file = "clients.pickle"
96
97
logger = logging.getLogger()
98
syslogger = None
99
100
try:
101
if_nametoindex = (ctypes.cdll.LoadLibrary
102
(ctypes.util.find_library("c"))
103
.if_nametoindex)
104
except (OSError, AttributeError):
105
def if_nametoindex(interface):
106
"Get an interface index the hard way, i.e. using fcntl()"
107
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
108
with contextlib.closing(socket.socket()) as s:
109
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
110
struct.pack(b"16s16x", interface))
111
interface_index = struct.unpack("I", ifreq[16:20])[0]
112
return interface_index
113
114
115
def initlogger(debug, level=logging.WARNING):
116
"""init logger and add loglevel"""
117
118
global syslogger
119
syslogger = (logging.handlers.SysLogHandler
120
(facility =
121
logging.handlers.SysLogHandler.LOG_DAEMON,
122
address = "/dev/log"))
123
syslogger.setFormatter(logging.Formatter
124
('Mandos [%(process)d]: %(levelname)s:'
125
' %(message)s'))
126
logger.addHandler(syslogger)
127
128
if debug:
129
console = logging.StreamHandler()
130
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
131
' [%(process)d]:'
132
' %(levelname)s:'
133
' %(message)s'))
134
logger.addHandler(console)
135
logger.setLevel(level)
136
137
138
class PGPError(Exception):
139
"""Exception if encryption/decryption fails"""
140
pass
141
142
143
class PGPEngine(object):
144
"""A simple class for OpenPGP symmetric encryption & decryption"""
145
def __init__(self):
146
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
147
self.gnupgargs = ['--batch',
148
'--home', self.tempdir,
149
'--force-mdc',
150
'--quiet',
151
'--no-use-agent']
152
153
def __enter__(self):
154
return self
155
156
def __exit__(self, exc_type, exc_value, traceback):
157
self._cleanup()
158
return False
159
160
def __del__(self):
161
self._cleanup()
162
163
def _cleanup(self):
164
if self.tempdir is not None:
165
# Delete contents of tempdir
166
for root, dirs, files in os.walk(self.tempdir,
167
topdown = False):
168
for filename in files:
169
os.remove(os.path.join(root, filename))
170
for dirname in dirs:
171
os.rmdir(os.path.join(root, dirname))
172
# Remove tempdir
173
os.rmdir(self.tempdir)
174
self.tempdir = None
175
176
def password_encode(self, password):
177
# Passphrase can not be empty and can not contain newlines or
178
# NUL bytes. So we prefix it and hex encode it.
179
encoded = b"mandos" + binascii.hexlify(password)
180
if len(encoded) > 2048:
181
# GnuPG can't handle long passwords, so encode differently
182
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
183
.replace(b"\n", b"\\n")
184
.replace(b"\0", b"\\x00"))
185
return encoded
186
187
def encrypt(self, data, password):
188
passphrase = self.password_encode(password)
189
with tempfile.NamedTemporaryFile(dir=self.tempdir
190
) as passfile:
191
passfile.write(passphrase)
192
passfile.flush()
193
proc = subprocess.Popen(['gpg', '--symmetric',
194
'--passphrase-file',
195
passfile.name]
196
+ self.gnupgargs,
197
stdin = subprocess.PIPE,
198
stdout = subprocess.PIPE,
199
stderr = subprocess.PIPE)
200
ciphertext, err = proc.communicate(input = data)
201
if proc.returncode != 0:
202
raise PGPError(err)
203
return ciphertext
204
205
def decrypt(self, data, password):
206
passphrase = self.password_encode(password)
207
with tempfile.NamedTemporaryFile(dir = self.tempdir
208
) as passfile:
209
passfile.write(passphrase)
210
passfile.flush()
211
proc = subprocess.Popen(['gpg', '--decrypt',
212
'--passphrase-file',
213
passfile.name]
214
+ self.gnupgargs,
215
stdin = subprocess.PIPE,
216
stdout = subprocess.PIPE,
217
stderr = subprocess.PIPE)
218
decrypted_plaintext, err = proc.communicate(input
219
= data)
220
if proc.returncode != 0:
221
raise PGPError(err)
222
return decrypted_plaintext
223
94
224
95
225
class AvahiError(Exception):
96
226
def __init__(self, value, *args, **kwargs):
97
227
self.value = value
98
super(AvahiError, self).__init__(value, *args, **kwargs)
99
def __unicode__(self):
100
return unicode(repr(self.value))
228
return super(AvahiError, self).__init__(value, *args,
229
**kwargs)
101
230
102
231
class AvahiServiceError(AvahiError):
103
232
pass
114
243
Used to optionally bind to the specified interface.
115
244
name: string; Example: 'Mandos'
116
245
type: string; Example: '_mandos._tcp'.
117
See <http://www.dns-sd.org/ServiceTypes.html>
246
See <https://www.iana.org/assignments/service-names-port-numbers>
118
247
port: integer; what port to announce
119
248
TXT: list of strings; TXT record for the service
120
249
domain: string; Domain to publish on, default to .local if empty.
122
251
max_renames: integer; maximum number of renames
123
252
rename_count: integer; counter so we only rename after collisions
124
253
a sensible number of times
254
group: D-Bus Entry Group
255
server: D-Bus Server
256
bus: dbus.SystemBus()
125
257
"""
258
126
259
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
127
260
servicetype = None, port = None, TXT = None,
128
261
domain = "", host = "", max_renames = 32768,
129
protocol = avahi.PROTO_UNSPEC):
262
protocol = avahi.PROTO_UNSPEC, bus = None):
130
263
self.interface = interface
131
264
self.name = name
132
265
self.type = servicetype
137
270
self.rename_count = 0
138
271
self.max_renames = max_renames
139
272
self.protocol = protocol
140
def rename(self):
273
self.group = None # our entry group
274
self.server = None
275
self.bus = bus
276
self.entry_group_state_changed_match = None
277
278
def rename(self, remove=True):
141
279
"""Derived from the Avahi example code"""
142
280
if self.rename_count >= self.max_renames:
143
logger.critical(u"No suitable Zeroconf service name found"
144
u" after %i retries, exiting.",
281
logger.critical("No suitable Zeroconf service name found"
282
" after %i retries, exiting.",
145
283
self.rename_count)
146
raise AvahiServiceError(u"Too many renames")
147
self.name = server.GetAlternativeServiceName(self.name)
148
logger.info(u"Changing Zeroconf service name to %r ...",
149
str(self.name))
150
syslogger.setFormatter(logging.Formatter
151
('Mandos (%s) [%%(process)d]:'
152
' %%(levelname)s: %%(message)s'
153
% self.name))
154
self.remove()
155
self.add()
284
raise AvahiServiceError("Too many renames")
285
self.name = str(self.server
286
.GetAlternativeServiceName(self.name))
156
287
self.rename_count += 1
288
logger.info("Changing Zeroconf service name to %r ...",
289
self.name)
290
if remove:
291
self.remove()
292
try:
293
self.add()
294
except dbus.exceptions.DBusException as error:
295
if (error.get_dbus_name()
296
== "org.freedesktop.Avahi.CollisionError"):
297
logger.info("Local Zeroconf service name collision.")
298
return self.rename(remove=False)
299
else:
300
logger.critical("D-Bus Exception", exc_info=error)
301
self.cleanup()
302
os._exit(1)
303
157
304
def remove(self):
158
305
"""Derived from the Avahi example code"""
159
if group is not None:
160
group.Reset()
306
if self.entry_group_state_changed_match is not None:
307
self.entry_group_state_changed_match.remove()
308
self.entry_group_state_changed_match = None
309
if self.group is not None:
310
self.group.Reset()
311
161
312
def add(self):
162
313
"""Derived from the Avahi example code"""
163
global group
164
if group is None:
165
group = dbus.Interface(bus.get_object
166
(avahi.DBUS_NAME,
167
server.EntryGroupNew()),
168
avahi.DBUS_INTERFACE_ENTRY_GROUP)
169
group.connect_to_signal('StateChanged',
170
entry_group_state_changed)
171
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
172
service.name, service.type)
173
group.AddService(
174
self.interface, # interface
175
self.protocol, # protocol
176
dbus.UInt32(0), # flags
177
self.name, self.type,
178
self.domain, self.host,
179
dbus.UInt16(self.port),
180
avahi.string_array_to_txt_array(self.TXT))
181
group.Commit()
182
183
# From the Avahi example code:
184
group = None # our entry group
185
# End of Avahi example code
186
187
188
def _datetime_to_dbus(dt, variant_level=0):
189
"""Convert a UTC datetime.datetime() to a D-Bus type."""
190
return dbus.String(dt.isoformat(), variant_level=variant_level)
314
self.remove()
315
if self.group is None:
316
self.group = dbus.Interface(
317
self.bus.get_object(avahi.DBUS_NAME,
318
self.server.EntryGroupNew()),
319
avahi.DBUS_INTERFACE_ENTRY_GROUP)
320
self.entry_group_state_changed_match = (
321
self.group.connect_to_signal(
322
'StateChanged', self.entry_group_state_changed))
323
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
324
self.name, self.type)
325
self.group.AddService(
326
self.interface,
327
self.protocol,
328
dbus.UInt32(0), # flags
329
self.name, self.type,
330
self.domain, self.host,
331
dbus.UInt16(self.port),
332
avahi.string_array_to_txt_array(self.TXT))
333
self.group.Commit()
334
335
def entry_group_state_changed(self, state, error):
336
"""Derived from the Avahi example code"""
337
logger.debug("Avahi entry group state change: %i", state)
338
339
if state == avahi.ENTRY_GROUP_ESTABLISHED:
340
logger.debug("Zeroconf service established.")
341
elif state == avahi.ENTRY_GROUP_COLLISION:
342
logger.info("Zeroconf service name collision.")
343
self.rename()
344
elif state == avahi.ENTRY_GROUP_FAILURE:
345
logger.critical("Avahi: Error in group state changed %s",
346
str(error))
347
raise AvahiGroupError("State changed: {!s}"
348
.format(error))
349
350
def cleanup(self):
351
"""Derived from the Avahi example code"""
352
if self.group is not None:
353
try:
354
self.group.Free()
355
except (dbus.exceptions.UnknownMethodException,
356
dbus.exceptions.DBusException):
357
pass
358
self.group = None
359
self.remove()
360
361
def server_state_changed(self, state, error=None):
362
"""Derived from the Avahi example code"""
363
logger.debug("Avahi server state change: %i", state)
364
bad_states = { avahi.SERVER_INVALID:
365
"Zeroconf server invalid",
366
avahi.SERVER_REGISTERING: None,
367
avahi.SERVER_COLLISION:
368
"Zeroconf server name collision",
369
avahi.SERVER_FAILURE:
370
"Zeroconf server failure" }
371
if state in bad_states:
372
if bad_states[state] is not None:
373
if error is None:
374
logger.error(bad_states[state])
375
else:
376
logger.error(bad_states[state] + ": %r", error)
377
self.cleanup()
378
elif state == avahi.SERVER_RUNNING:
379
self.add()
380
else:
381
if error is None:
382
logger.debug("Unknown state: %r", state)
383
else:
384
logger.debug("Unknown state: %r: %r", state, error)
385
386
def activate(self):
387
"""Derived from the Avahi example code"""
388
if self.server is None:
389
self.server = dbus.Interface(
390
self.bus.get_object(avahi.DBUS_NAME,
391
avahi.DBUS_PATH_SERVER,
392
follow_name_owner_changes=True),
393
avahi.DBUS_INTERFACE_SERVER)
394
self.server.connect_to_signal("StateChanged",
395
self.server_state_changed)
396
self.server_state_changed(self.server.GetState())
397
398
399
class AvahiServiceToSyslog(AvahiService):
400
def rename(self, *args, **kwargs):
401
"""Add the new name to the syslog messages"""
402
ret = AvahiService.rename(self, *args, **kwargs)
403
syslogger.setFormatter(logging.Formatter
404
('Mandos ({}) [%(process)d]:'
405
' %(levelname)s: %(message)s'
406
.format(self.name)))
407
return ret
191
408
192
409
193
410
class Client(object):
194
411
"""A representation of a client host served by this server.
195
412
196
413
Attributes:
197
name: string; from the config file, used in log messages and
198
D-Bus identifiers
199
fingerprint: string (40 or 32 hexadecimal digits); used to
200
uniquely identify the client
201
secret: bytestring; sent verbatim (over TLS) to client
202
host: string; available for use by the checker command
203
created: datetime.datetime(); (UTC) object creation
204
last_enabled: datetime.datetime(); (UTC)
205
enabled: bool()
206
last_checked_ok: datetime.datetime(); (UTC) or None
207
timeout: datetime.timedelta(); How long from last_checked_ok
208
until this client is invalid
209
interval: datetime.timedelta(); How often to start a new checker
210
disable_hook: If set, called by disable() as disable_hook(self)
414
approved: bool(); 'None' if not yet approved/disapproved
415
approval_delay: datetime.timedelta(); Time to wait for approval
416
approval_duration: datetime.timedelta(); Duration of one approval
211
417
checker: subprocess.Popen(); a running checker process used
212
418
to see if the client lives.
213
419
'None' if no process is running.
214
checker_initiator_tag: a gobject event source tag, or None
215
disable_initiator_tag: - '' -
216
checker_callback_tag: - '' -
217
checker_command: string; External command which is run to check if
218
client lives. %() expansions are done at
420
checker_callback_tag: a gobject event source tag, or None
421
checker_command: string; External command which is run to check
422
if client lives. %() expansions are done at
219
423
runtime with vars(self) as dict, so that for
220
424
instance %(name)s can be used in the command.
425
checker_initiator_tag: a gobject event source tag, or None
426
created: datetime.datetime(); (UTC) object creation
427
client_structure: Object describing what attributes a client has
428
and is used for storing the client at exit
221
429
current_checker_command: string; current running checker_command
430
disable_initiator_tag: a gobject event source tag, or None
431
enabled: bool()
432
fingerprint: string (40 or 32 hexadecimal digits); used to
433
uniquely identify the client
434
host: string; available for use by the checker command
435
interval: datetime.timedelta(); How often to start a new checker
436
last_approval_request: datetime.datetime(); (UTC) or None
437
last_checked_ok: datetime.datetime(); (UTC) or None
438
last_checker_status: integer between 0 and 255 reflecting exit
439
status of last checker. -1 reflects crashed
440
checker, -2 means no checker completed yet.
441
last_enabled: datetime.datetime(); (UTC) or None
442
name: string; from the config file, used in log messages and
443
D-Bus identifiers
444
secret: bytestring; sent verbatim (over TLS) to client
445
timeout: datetime.timedelta(); How long from last_checked_ok
446
until this client is disabled
447
extended_timeout: extra long timeout when secret has been sent
448
runtime_expansions: Allowed attributes for runtime expansion.
449
expires: datetime.datetime(); time (UTC) when a client will be
450
disabled, or None
451
server_settings: The server_settings dict from main()
222
452
"""
223
def timeout_milliseconds(self):
224
"Return the 'timeout' attribute in milliseconds"
225
return ((self.timeout.days * 24 * 60 * 60 * 1000)
226
+ (self.timeout.seconds * 1000)
227
+ (self.timeout.microseconds // 1000))
228
229
def interval_milliseconds(self):
230
"Return the 'interval' attribute in milliseconds"
231
return ((self.interval.days * 24 * 60 * 60 * 1000)
232
+ (self.interval.seconds * 1000)
233
+ (self.interval.microseconds // 1000))
234
235
def __init__(self, name = None, disable_hook=None, config=None):
236
"""Note: the 'checker' key in 'config' sets the
237
'checker_command' attribute and *not* the 'checker'
238
attribute."""
453
454
runtime_expansions = ("approval_delay", "approval_duration",
455
"created", "enabled", "expires",
456
"fingerprint", "host", "interval",
457
"last_approval_request", "last_checked_ok",
458
"last_enabled", "name", "timeout")
459
client_defaults = { "timeout": "PT5M",
460
"extended_timeout": "PT15M",
461
"interval": "PT2M",
462
"checker": "fping -q -- %%(host)s",
463
"host": "",
464
"approval_delay": "PT0S",
465
"approval_duration": "PT1S",
466
"approved_by_default": "True",
467
"enabled": "True",
468
}
469
470
@staticmethod
471
def config_parser(config):
472
"""Construct a new dict of client settings of this form:
473
{ client_name: {setting_name: value, ...}, ...}
474
with exceptions for any special settings as defined above.
475
NOTE: Must be a pure function. Must return the same result
476
value given the same arguments.
477
"""
478
settings = {}
479
for client_name in config.sections():
480
section = dict(config.items(client_name))
481
client = settings[client_name] = {}
482
483
client["host"] = section["host"]
484
# Reformat values from string types to Python types
485
client["approved_by_default"] = config.getboolean(
486
client_name, "approved_by_default")
487
client["enabled"] = config.getboolean(client_name,
488
"enabled")
489
490
# Uppercase and remove spaces from fingerprint for later
491
# comparison purposes with return value from the
492
# fingerprint() function
493
client["fingerprint"] = (section["fingerprint"].upper()
494
.replace(" ", ""))
495
if "secret" in section:
496
client["secret"] = section["secret"].decode("base64")
497
elif "secfile" in section:
498
with open(os.path.expanduser(os.path.expandvars
499
(section["secfile"])),
500
"rb") as secfile:
501
client["secret"] = secfile.read()
502
else:
503
raise TypeError("No secret or secfile for section {}"
504
.format(section))
505
client["timeout"] = string_to_delta(section["timeout"])
506
client["extended_timeout"] = string_to_delta(
507
section["extended_timeout"])
508
client["interval"] = string_to_delta(section["interval"])
509
client["approval_delay"] = string_to_delta(
510
section["approval_delay"])
511
client["approval_duration"] = string_to_delta(
512
section["approval_duration"])
513
client["checker_command"] = section["checker"]
514
client["last_approval_request"] = None
515
client["last_checked_ok"] = None
516
client["last_checker_status"] = -2
517
518
return settings
519
520
def __init__(self, settings, name = None, server_settings=None):
239
521
self.name = name
240
if config is None:
241
config = {}
242
logger.debug(u"Creating client %r", self.name)
243
# Uppercase and remove spaces from fingerprint for later
244
# comparison purposes with return value from the fingerprint()
245
# function
246
self.fingerprint = (config["fingerprint"].upper()
247
.replace(u" ", u""))
248
logger.debug(u" Fingerprint: %s", self.fingerprint)
249
if "secret" in config:
250
self.secret = config["secret"].decode(u"base64")
251
elif "secfile" in config:
252
with closing(open(os.path.expanduser
253
(os.path.expandvars
254
(config["secfile"])))) as secfile:
255
self.secret = secfile.read()
522
if server_settings is None:
523
server_settings = {}
524
self.server_settings = server_settings
525
# adding all client settings
526
for setting, value in settings.items():
527
setattr(self, setting, value)
528
529
if self.enabled:
530
if not hasattr(self, "last_enabled"):
531
self.last_enabled = datetime.datetime.utcnow()
532
if not hasattr(self, "expires"):
533
self.expires = (datetime.datetime.utcnow()
534
+ self.timeout)
256
535
else:
257
raise TypeError(u"No secret or secfile for client %s"
258
% self.name)
259
self.host = config.get("host", "")
260
self.created = datetime.datetime.utcnow()
261
self.enabled = False
262
self.last_enabled = None
263
self.last_checked_ok = None
264
self.timeout = string_to_delta(config["timeout"])
265
self.interval = string_to_delta(config["interval"])
266
self.disable_hook = disable_hook
536
self.last_enabled = None
537
self.expires = None
538
539
logger.debug("Creating client %r", self.name)
540
logger.debug(" Fingerprint: %s", self.fingerprint)
541
self.created = settings.get("created",
542
datetime.datetime.utcnow())
543
544
# attributes specific for this server instance
267
545
self.checker = None
268
546
self.checker_initiator_tag = None
269
547
self.disable_initiator_tag = None
270
548
self.checker_callback_tag = None
271
self.checker_command = config["checker"]
272
549
self.current_checker_command = None
273
self.last_connect = None
550
self.approved = None
551
self.approvals_pending = 0
552
self.changedstate = (multiprocessing_manager
553
.Condition(multiprocessing_manager
554
.Lock()))
555
self.client_structure = [attr for attr in
556
self.__dict__.iterkeys()
557
if not attr.startswith("_")]
558
self.client_structure.append("client_structure")
559
560
for name, t in inspect.getmembers(type(self),
561
lambda obj:
562
isinstance(obj,
563
property)):
564
if not name.startswith("_"):
565
self.client_structure.append(name)
566
567
# Send notice to process children that client state has changed
568
def send_changedstate(self):
569
with self.changedstate:
570
self.changedstate.notify_all()
274
571
275
572
def enable(self):
276
573
"""Start this client's checker and timeout hooks"""
574
if getattr(self, "enabled", False):
575
# Already enabled
576
return
577
self.expires = datetime.datetime.utcnow() + self.timeout
578
self.enabled = True
277
579
self.last_enabled = datetime.datetime.utcnow()
580
self.init_checker()
581
self.send_changedstate()
582
583
def disable(self, quiet=True):
584
"""Disable this client."""
585
if not getattr(self, "enabled", False):
586
return False
587
if not quiet:
588
logger.info("Disabling client %s", self.name)
589
if getattr(self, "disable_initiator_tag", None) is not None:
590
gobject.source_remove(self.disable_initiator_tag)
591
self.disable_initiator_tag = None
592
self.expires = None
593
if getattr(self, "checker_initiator_tag", None) is not None:
594
gobject.source_remove(self.checker_initiator_tag)
595
self.checker_initiator_tag = None
596
self.stop_checker()
597
self.enabled = False
598
if not quiet:
599
self.send_changedstate()
600
# Do not run this again if called by a gobject.timeout_add
601
return False
602
603
def __del__(self):
604
self.disable()
605
606
def init_checker(self):
278
607
# Schedule a new checker to be started an 'interval' from now,
279
608
# and every interval from then on.
609
if self.checker_initiator_tag is not None:
610
gobject.source_remove(self.checker_initiator_tag)
280
611
self.checker_initiator_tag = (gobject.timeout_add
281
(self.interval_milliseconds(),
612
(int(self.interval
613
.total_seconds() * 1000),
282
614
self.start_checker))
615
# Schedule a disable() when 'timeout' has passed
616
if self.disable_initiator_tag is not None:
617
gobject.source_remove(self.disable_initiator_tag)
618
self.disable_initiator_tag = (gobject.timeout_add
619
(int(self.timeout
620
.total_seconds() * 1000),
621
self.disable))
283
622
# Also start a new checker *right now*.
284
623
self.start_checker()
285
# Schedule a disable() when 'timeout' has passed
286
self.disable_initiator_tag = (gobject.timeout_add
287
(self.timeout_milliseconds(),
288
self.disable))
289
self.enabled = True
290
291
def disable(self):
292
"""Disable this client."""
293
if not getattr(self, "enabled", False):
294
return False
295
logger.info(u"Disabling client %s", self.name)
296
if getattr(self, "disable_initiator_tag", False):
297
gobject.source_remove(self.disable_initiator_tag)
298
self.disable_initiator_tag = None
299
if getattr(self, "checker_initiator_tag", False):
300
gobject.source_remove(self.checker_initiator_tag)
301
self.checker_initiator_tag = None
302
self.stop_checker()
303
if self.disable_hook:
304
self.disable_hook(self)
305
self.enabled = False
306
# Do not run this again if called by a gobject.timeout_add
307
return False
308
309
def __del__(self):
310
self.disable_hook = None
311
self.disable()
312
624
313
625
def checker_callback(self, pid, condition, command):
314
626
"""The checker has completed, so take appropriate actions."""
315
627
self.checker_callback_tag = None
316
628
self.checker = None
317
629
if os.WIFEXITED(condition):
318
exitstatus = os.WEXITSTATUS(condition)
319
if exitstatus == 0:
320
logger.info(u"Checker for %(name)s succeeded",
630
self.last_checker_status = os.WEXITSTATUS(condition)
631
if self.last_checker_status == 0:
632
logger.info("Checker for %(name)s succeeded",
321
633
vars(self))
322
634
self.checked_ok()
323
635
else:
324
logger.info(u"Checker for %(name)s failed",
636
logger.info("Checker for %(name)s failed",
325
637
vars(self))
326
638
else:
327
logger.warning(u"Checker for %(name)s crashed?",
639
self.last_checker_status = -1
640
logger.warning("Checker for %(name)s crashed?",
328
641
vars(self))
329
642
330
643
def checked_ok(self):
331
"""Bump up the timeout for this client.
332
333
This should only be called when the client has been seen,
334
alive and well.
335
"""
644
"""Assert that the client has been seen, alive and well."""
336
645
self.last_checked_ok = datetime.datetime.utcnow()
337
gobject.source_remove(self.disable_initiator_tag)
338
self.disable_initiator_tag = (gobject.timeout_add
339
(self.timeout_milliseconds(),
340
self.disable))
646
self.last_checker_status = 0
647
self.bump_timeout()
648
649
def bump_timeout(self, timeout=None):
650
"""Bump up the timeout for this client."""
651
if timeout is None:
652
timeout = self.timeout
653
if self.disable_initiator_tag is not None:
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = None
656
if getattr(self, "enabled", False):
657
self.disable_initiator_tag = (gobject.timeout_add
658
(int(timeout.total_seconds()
659
* 1000), self.disable))
660
self.expires = datetime.datetime.utcnow() + timeout
661
662
def need_approval(self):
663
self.last_approval_request = datetime.datetime.utcnow()
341
664
342
665
def start_checker(self):
343
666
"""Start a new checker subprocess if one is not running.
345
668
If a checker already exists, leave it running and do
346
669
nothing."""
347
670
# The reason for not killing a running checker is that if we
348
# did that, then if a checker (for some reason) started
349
# running slowly and taking more than 'interval' time, the
350
# client would inevitably timeout, since no checker would get
351
# a chance to run to completion. If we instead leave running
671
# did that, and if a checker (for some reason) started running
672
# slowly and taking more than 'interval' time, then the client
673
# would inevitably timeout, since no checker would get a
674
# chance to run to completion. If we instead leave running
352
675
# checkers alone, the checker would have to take more time
353
# than 'timeout' for the client to be declared invalid, which
354
# is as it should be.
676
# than 'timeout' for the client to be disabled, which is as it
677
# should be.
355
678
356
679
# If a checker exists, make sure it is not a zombie
357
if self.checker is not None:
680
try:
358
681
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
682
except AttributeError:
683
pass
684
except OSError as error:
685
if error.errno != errno.ECHILD:
686
raise
687
else:
359
688
if pid:
360
689
logger.warning("Checker was a zombie")
361
690
gobject.source_remove(self.checker_callback_tag)
363
692
self.current_checker_command)
364
693
# Start a new checker if needed
365
694
if self.checker is None:
695
# Escape attributes for the shell
696
escaped_attrs = { attr:
697
re.escape(str(getattr(self, attr)))
698
for attr in self.runtime_expansions }
366
699
try:
367
# In case checker_command has exactly one % operator
368
command = self.checker_command % self.host
369
except TypeError:
370
# Escape attributes for the shell
371
escaped_attrs = dict((key, re.escape(str(val)))
372
for key, val in
373
vars(self).iteritems())
374
try:
375
command = self.checker_command % escaped_attrs
376
except TypeError, error:
377
logger.error(u'Could not format string "%s":'
378
u' %s', self.checker_command, error)
379
return True # Try again later
700
command = self.checker_command % escaped_attrs
701
except TypeError as error:
702
logger.error('Could not format string "%s"',
703
self.checker_command, exc_info=error)
704
return True # Try again later
380
705
self.current_checker_command = command
381
706
try:
382
logger.info(u"Starting checker %r for %s",
707
logger.info("Starting checker %r for %s",
383
708
command, self.name)
384
709
# We don't need to redirect stdout and stderr, since
385
710
# in normal mode, that is already done by daemon(),
386
711
# and in debug mode we don't want to. (Stdin is
387
712
# always replaced by /dev/null.)
713
# The exception is when not debugging but nevertheless
714
# running in the foreground; use the previously
715
# created wnull.
716
popen_args = {}
717
if (not self.server_settings["debug"]
718
and self.server_settings["foreground"]):
719
popen_args.update({"stdout": wnull,
720
"stderr": wnull })
388
721
self.checker = subprocess.Popen(command,
389
722
close_fds=True,
390
shell=True, cwd="/")
391
self.checker_callback_tag = (gobject.child_watch_add
392
(self.checker.pid,
393
self.checker_callback,
394
data=command))
395
# The checker may have completed before the gobject
396
# watch was added. Check for this.
723
shell=True, cwd="/",
724
**popen_args)
725
except OSError as error:
726
logger.error("Failed to start subprocess",
727
exc_info=error)
728
return True
729
self.checker_callback_tag = (gobject.child_watch_add
730
(self.checker.pid,
731
self.checker_callback,
732
data=command))
733
# The checker may have completed before the gobject
734
# watch was added. Check for this.
735
try:
397
736
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
398
if pid:
399
gobject.source_remove(self.checker_callback_tag)
400
self.checker_callback(pid, status, command)
401
except OSError, error:
402
logger.error(u"Failed to start subprocess: %s",
403
error)
737
except OSError as error:
738
if error.errno == errno.ECHILD:
739
# This should never happen
740
logger.error("Child process vanished",
741
exc_info=error)
742
return True
743
raise
744
if pid:
745
gobject.source_remove(self.checker_callback_tag)
746
self.checker_callback(pid, status, command)
404
747
# Re-run this periodically if run by gobject.timeout_add
405
748
return True
406
749
411
754
self.checker_callback_tag = None
412
755
if getattr(self, "checker", None) is None:
413
756
return
414
logger.debug(u"Stopping checker for %(name)s", vars(self))
757
logger.debug("Stopping checker for %(name)s", vars(self))
415
758
try:
416
os.kill(self.checker.pid, signal.SIGTERM)
417
#os.sleep(0.5)
759
self.checker.terminate()
760
#time.sleep(0.5)
418
761
#if self.checker.poll() is None:
419
# os.kill(self.checker.pid, signal.SIGKILL)
420
except OSError, error:
762
# self.checker.kill()
763
except OSError as error:
421
764
if error.errno != errno.ESRCH: # No such process
422
765
raise
423
766
self.checker = None
424
425
def still_valid(self):
426
"""Has the timeout not yet passed for this client?"""
427
if not getattr(self, "enabled", False):
428
return False
429
now = datetime.datetime.utcnow()
430
if self.last_checked_ok is None:
431
return now < (self.created + self.timeout)
432
else:
433
return now < (self.last_checked_ok + self.timeout)
434
435
436
class ClientDBus(Client, dbus.service.Object):
767
768
769
def dbus_service_property(dbus_interface, signature="v",
770
access="readwrite", byte_arrays=False):
771
"""Decorators for marking methods of a DBusObjectWithProperties to
772
become properties on the D-Bus.
773
774
The decorated method will be called with no arguments by "Get"
775
and with one argument by "Set".
776
777
The parameters, where they are supported, are the same as
778
dbus.service.method, except there is only "signature", since the
779
type from Get() and the type sent to Set() is the same.
780
"""
781
# Encoding deeply encoded byte arrays is not supported yet by the
782
# "Set" method, so we fail early here:
783
if byte_arrays and signature != "ay":
784
raise ValueError("Byte arrays not supported for non-'ay'"
785
" signature {!r}".format(signature))
786
def decorator(func):
787
func._dbus_is_property = True
788
func._dbus_interface = dbus_interface
789
func._dbus_signature = signature
790
func._dbus_access = access
791
func._dbus_name = func.__name__
792
if func._dbus_name.endswith("_dbus_property"):
793
func._dbus_name = func._dbus_name[:-14]
794
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
795
return func
796
return decorator
797
798
799
def dbus_interface_annotations(dbus_interface):
800
"""Decorator for marking functions returning interface annotations
801
802
Usage:
803
804
@dbus_interface_annotations("org.example.Interface")
805
def _foo(self): # Function name does not matter
806
return {"org.freedesktop.DBus.Deprecated": "true",
807
"org.freedesktop.DBus.Property.EmitsChangedSignal":
808
"false"}
809
"""
810
def decorator(func):
811
func._dbus_is_interface = True
812
func._dbus_interface = dbus_interface
813
func._dbus_name = dbus_interface
814
return func
815
return decorator
816
817
818
def dbus_annotations(annotations):
819
"""Decorator to annotate D-Bus methods, signals or properties
820
Usage:
821
822
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
823
"org.freedesktop.DBus.Property."
824
"EmitsChangedSignal": "false"})
825
@dbus_service_property("org.example.Interface", signature="b",
826
access="r")
827
def Property_dbus_property(self):
828
return dbus.Boolean(False)
829
"""
830
def decorator(func):
831
func._dbus_annotations = annotations
832
return func
833
return decorator
834
835
836
class DBusPropertyException(dbus.exceptions.DBusException):
837
"""A base class for D-Bus property-related exceptions
838
"""
839
pass
840
841
class DBusPropertyAccessException(DBusPropertyException):
842
"""A property's access permissions disallows an operation.
843
"""
844
pass
845
846
847
class DBusPropertyNotFound(DBusPropertyException):
848
"""An attempt was made to access a non-existing property.
849
"""
850
pass
851
852
853
class DBusObjectWithProperties(dbus.service.Object):
854
"""A D-Bus object with properties.
855
856
Classes inheriting from this can use the dbus_service_property
857
decorator to expose methods as D-Bus properties. It exposes the
858
standard Get(), Set(), and GetAll() methods on the D-Bus.
859
"""
860
861
@staticmethod
862
def _is_dbus_thing(thing):
863
"""Returns a function testing if an attribute is a D-Bus thing
864
865
If called like _is_dbus_thing("method") it returns a function
866
suitable for use as predicate to inspect.getmembers().
867
"""
868
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
869
False)
870
871
def _get_all_dbus_things(self, thing):
872
"""Returns a generator of (name, attribute) pairs
873
"""
874
return ((getattr(athing.__get__(self), "_dbus_name",
875
name),
876
athing.__get__(self))
877
for cls in self.__class__.__mro__
878
for name, athing in
879
inspect.getmembers(cls,
880
self._is_dbus_thing(thing)))
881
882
def _get_dbus_property(self, interface_name, property_name):
883
"""Returns a bound method if one exists which is a D-Bus
884
property with the specified name and interface.
885
"""
886
for cls in self.__class__.__mro__:
887
for name, value in (inspect.getmembers
888
(cls,
889
self._is_dbus_thing("property"))):
890
if (value._dbus_name == property_name
891
and value._dbus_interface == interface_name):
892
return value.__get__(self)
893
894
# No such property
895
raise DBusPropertyNotFound(self.dbus_object_path + ":"
896
+ interface_name + "."
897
+ property_name)
898
899
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
900
out_signature="v")
901
def Get(self, interface_name, property_name):
902
"""Standard D-Bus property Get() method, see D-Bus standard.
903
"""
904
prop = self._get_dbus_property(interface_name, property_name)
905
if prop._dbus_access == "write":
906
raise DBusPropertyAccessException(property_name)
907
value = prop()
908
if not hasattr(value, "variant_level"):
909
return value
910
return type(value)(value, variant_level=value.variant_level+1)
911
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
913
def Set(self, interface_name, property_name, value):
914
"""Standard D-Bus property Set() method, see D-Bus standard.
915
"""
916
prop = self._get_dbus_property(interface_name, property_name)
917
if prop._dbus_access == "read":
918
raise DBusPropertyAccessException(property_name)
919
if prop._dbus_get_args_options["byte_arrays"]:
920
# The byte_arrays option is not supported yet on
921
# signatures other than "ay".
922
if prop._dbus_signature != "ay":
923
raise ValueError("Byte arrays not supported for non-"
924
"'ay' signature {!r}"
925
.format(prop._dbus_signature))
926
value = dbus.ByteArray(b''.join(chr(byte)
927
for byte in value))
928
prop(value)
929
930
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
931
out_signature="a{sv}")
932
def GetAll(self, interface_name):
933
"""Standard D-Bus property GetAll() method, see D-Bus
934
standard.
935
936
Note: Will not include properties with access="write".
937
"""
938
properties = {}
939
for name, prop in self._get_all_dbus_things("property"):
940
if (interface_name
941
and interface_name != prop._dbus_interface):
942
# Interface non-empty but did not match
943
continue
944
# Ignore write-only properties
945
if prop._dbus_access == "write":
946
continue
947
value = prop()
948
if not hasattr(value, "variant_level"):
949
properties[name] = value
950
continue
951
properties[name] = type(value)(value, variant_level=
952
value.variant_level+1)
953
return dbus.Dictionary(properties, signature="sv")
954
955
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
956
def PropertiesChanged(self, interface_name, changed_properties,
957
invalidated_properties):
958
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
959
standard.
960
"""
961
pass
962
963
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
964
out_signature="s",
965
path_keyword='object_path',
966
connection_keyword='connection')
967
def Introspect(self, object_path, connection):
968
"""Overloading of standard D-Bus method.
969
970
Inserts property tags and interface annotation tags.
971
"""
972
xmlstring = dbus.service.Object.Introspect(self, object_path,
973
connection)
974
try:
975
document = xml.dom.minidom.parseString(xmlstring)
976
def make_tag(document, name, prop):
977
e = document.createElement("property")
978
e.setAttribute("name", name)
979
e.setAttribute("type", prop._dbus_signature)
980
e.setAttribute("access", prop._dbus_access)
981
return e
982
for if_tag in document.getElementsByTagName("interface"):
983
# Add property tags
984
for tag in (make_tag(document, name, prop)
985
for name, prop
986
in self._get_all_dbus_things("property")
987
if prop._dbus_interface
988
== if_tag.getAttribute("name")):
989
if_tag.appendChild(tag)
990
# Add annotation tags
991
for typ in ("method", "signal", "property"):
992
for tag in if_tag.getElementsByTagName(typ):
993
annots = dict()
994
for name, prop in (self.
995
_get_all_dbus_things(typ)):
996
if (name == tag.getAttribute("name")
997
and prop._dbus_interface
998
== if_tag.getAttribute("name")):
999
annots.update(getattr
1000
(prop,
1001
"_dbus_annotations",
1002
{}))
1003
for name, value in annots.items():
1004
ann_tag = document.createElement(
1005
"annotation")
1006
ann_tag.setAttribute("name", name)
1007
ann_tag.setAttribute("value", value)
1008
tag.appendChild(ann_tag)
1009
# Add interface annotation tags
1010
for annotation, value in dict(
1011
itertools.chain.from_iterable(
1012
annotations().items()
1013
for name, annotations in
1014
self._get_all_dbus_things("interface")
1015
if name == if_tag.getAttribute("name")
1016
)).items():
1017
ann_tag = document.createElement("annotation")
1018
ann_tag.setAttribute("name", annotation)
1019
ann_tag.setAttribute("value", value)
1020
if_tag.appendChild(ann_tag)
1021
# Add the names to the return values for the
1022
# "org.freedesktop.DBus.Properties" methods
1023
if (if_tag.getAttribute("name")
1024
== "org.freedesktop.DBus.Properties"):
1025
for cn in if_tag.getElementsByTagName("method"):
1026
if cn.getAttribute("name") == "Get":
1027
for arg in cn.getElementsByTagName("arg"):
1028
if (arg.getAttribute("direction")
1029
== "out"):
1030
arg.setAttribute("name", "value")
1031
elif cn.getAttribute("name") == "GetAll":
1032
for arg in cn.getElementsByTagName("arg"):
1033
if (arg.getAttribute("direction")
1034
== "out"):
1035
arg.setAttribute("name", "props")
1036
xmlstring = document.toxml("utf-8")
1037
document.unlink()
1038
except (AttributeError, xml.dom.DOMException,
1039
xml.parsers.expat.ExpatError) as error:
1040
logger.error("Failed to override Introspection method",
1041
exc_info=error)
1042
return xmlstring
1043
1044
1045
def datetime_to_dbus(dt, variant_level=0):
1046
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1047
if dt is None:
1048
return dbus.String("", variant_level = variant_level)
1049
return dbus.String(dt.isoformat(),
1050
variant_level=variant_level)
1051
1052
1053
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1054
"""A class decorator; applied to a subclass of
1055
dbus.service.Object, it will add alternate D-Bus attributes with
1056
interface names according to the "alt_interface_names" mapping.
1057
Usage:
1058
1059
@alternate_dbus_interfaces({"org.example.Interface":
1060
"net.example.AlternateInterface"})
1061
class SampleDBusObject(dbus.service.Object):
1062
@dbus.service.method("org.example.Interface")
1063
def SampleDBusMethod():
1064
pass
1065
1066
The above "SampleDBusMethod" on "SampleDBusObject" will be
1067
reachable via two interfaces: "org.example.Interface" and
1068
"net.example.AlternateInterface", the latter of which will have
1069
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1070
"true", unless "deprecate" is passed with a False value.
1071
1072
This works for methods and signals, and also for D-Bus properties
1073
(from DBusObjectWithProperties) and interfaces (from the
1074
dbus_interface_annotations decorator).
1075
"""
1076
def wrapper(cls):
1077
for orig_interface_name, alt_interface_name in (
1078
alt_interface_names.items()):
1079
attr = {}
1080
interface_names = set()
1081
# Go though all attributes of the class
1082
for attrname, attribute in inspect.getmembers(cls):
1083
# Ignore non-D-Bus attributes, and D-Bus attributes
1084
# with the wrong interface name
1085
if (not hasattr(attribute, "_dbus_interface")
1086
or not attribute._dbus_interface
1087
.startswith(orig_interface_name)):
1088
continue
1089
# Create an alternate D-Bus interface name based on
1090
# the current name
1091
alt_interface = (attribute._dbus_interface
1092
.replace(orig_interface_name,
1093
alt_interface_name))
1094
interface_names.add(alt_interface)
1095
# Is this a D-Bus signal?
1096
if getattr(attribute, "_dbus_is_signal", False):
1097
# Extract the original non-method undecorated
1098
# function by black magic
1099
nonmethod_func = (dict(
1100
zip(attribute.func_code.co_freevars,
1101
attribute.__closure__))["func"]
1102
.cell_contents)
1103
# Create a new, but exactly alike, function
1104
# object, and decorate it to be a new D-Bus signal
1105
# with the alternate D-Bus interface name
1106
new_function = (dbus.service.signal
1107
(alt_interface,
1108
attribute._dbus_signature)
1109
(types.FunctionType(
1110
nonmethod_func.func_code,
1111
nonmethod_func.func_globals,
1112
nonmethod_func.func_name,
1113
nonmethod_func.func_defaults,
1114
nonmethod_func.func_closure)))
1115
# Copy annotations, if any
1116
try:
1117
new_function._dbus_annotations = (
1118
dict(attribute._dbus_annotations))
1119
except AttributeError:
1120
pass
1121
# Define a creator of a function to call both the
1122
# original and alternate functions, so both the
1123
# original and alternate signals gets sent when
1124
# the function is called
1125
def fixscope(func1, func2):
1126
"""This function is a scope container to pass
1127
func1 and func2 to the "call_both" function
1128
outside of its arguments"""
1129
def call_both(*args, **kwargs):
1130
"""This function will emit two D-Bus
1131
signals by calling func1 and func2"""
1132
func1(*args, **kwargs)
1133
func2(*args, **kwargs)
1134
return call_both
1135
# Create the "call_both" function and add it to
1136
# the class
1137
attr[attrname] = fixscope(attribute, new_function)
1138
# Is this a D-Bus method?
1139
elif getattr(attribute, "_dbus_is_method", False):
1140
# Create a new, but exactly alike, function
1141
# object. Decorate it to be a new D-Bus method
1142
# with the alternate D-Bus interface name. Add it
1143
# to the class.
1144
attr[attrname] = (dbus.service.method
1145
(alt_interface,
1146
attribute._dbus_in_signature,
1147
attribute._dbus_out_signature)
1148
(types.FunctionType
1149
(attribute.func_code,
1150
attribute.func_globals,
1151
attribute.func_name,
1152
attribute.func_defaults,
1153
attribute.func_closure)))
1154
# Copy annotations, if any
1155
try:
1156
attr[attrname]._dbus_annotations = (
1157
dict(attribute._dbus_annotations))
1158
except AttributeError:
1159
pass
1160
# Is this a D-Bus property?
1161
elif getattr(attribute, "_dbus_is_property", False):
1162
# Create a new, but exactly alike, function
1163
# object, and decorate it to be a new D-Bus
1164
# property with the alternate D-Bus interface
1165
# name. Add it to the class.
1166
attr[attrname] = (dbus_service_property
1167
(alt_interface,
1168
attribute._dbus_signature,
1169
attribute._dbus_access,
1170
attribute
1171
._dbus_get_args_options
1172
["byte_arrays"])
1173
(types.FunctionType
1174
(attribute.func_code,
1175
attribute.func_globals,
1176
attribute.func_name,
1177
attribute.func_defaults,
1178
attribute.func_closure)))
1179
# Copy annotations, if any
1180
try:
1181
attr[attrname]._dbus_annotations = (
1182
dict(attribute._dbus_annotations))
1183
except AttributeError:
1184
pass
1185
# Is this a D-Bus interface?
1186
elif getattr(attribute, "_dbus_is_interface", False):
1187
# Create a new, but exactly alike, function
1188
# object. Decorate it to be a new D-Bus interface
1189
# with the alternate D-Bus interface name. Add it
1190
# to the class.
1191
attr[attrname] = (dbus_interface_annotations
1192
(alt_interface)
1193
(types.FunctionType
1194
(attribute.func_code,
1195
attribute.func_globals,
1196
attribute.func_name,
1197
attribute.func_defaults,
1198
attribute.func_closure)))
1199
if deprecate:
1200
# Deprecate all alternate interfaces
1201
iname="_AlternateDBusNames_interface_annotation{}"
1202
for interface_name in interface_names:
1203
@dbus_interface_annotations(interface_name)
1204
def func(self):
1205
return { "org.freedesktop.DBus.Deprecated":
1206
"true" }
1207
# Find an unused name
1208
for aname in (iname.format(i)
1209
for i in itertools.count()):
1210
if aname not in attr:
1211
attr[aname] = func
1212
break
1213
if interface_names:
1214
# Replace the class with a new subclass of it with
1215
# methods, signals, etc. as created above.
1216
cls = type(b"{}Alternate".format(cls.__name__),
1217
(cls,), attr)
1218
return cls
1219
return wrapper
1220
1221
1222
@alternate_dbus_interfaces({"se.recompile.Mandos":
1223
"se.bsnet.fukt.Mandos"})
1224
class ClientDBus(Client, DBusObjectWithProperties):
437
1225
"""A Client class using D-Bus
438
1226
439
1227
Attributes:
440
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
1228
dbus_object_path: dbus.ObjectPath
1229
bus: dbus.SystemBus()
441
1230
"""
1231
1232
runtime_expansions = (Client.runtime_expansions
1233
+ ("dbus_object_path",))
1234
1235
_interface = "se.recompile.Mandos.Client"
1236
442
1237
# dbus.service.Object doesn't use super(), so we can't either.
443
1238
444
def __init__(self, *args, **kwargs):
1239
def __init__(self, bus = None, *args, **kwargs):
1240
self.bus = bus
445
1241
Client.__init__(self, *args, **kwargs)
446
1242
# Only now, when this client is initialized, can it show up on
447
1243
# the D-Bus
1244
client_object_name = str(self.name).translate(
1245
{ord("."): ord("_"),
1246
ord("-"): ord("_")})
448
1247
self.dbus_object_path = (dbus.ObjectPath
449
("/clients/"
450
+ self.name.replace(".", "_")))
451
dbus.service.Object.__init__(self, bus,
452
self.dbus_object_path)
453
def enable(self):
454
oldstate = getattr(self, "enabled", False)
455
r = Client.enable(self)
456
if oldstate != self.enabled:
457
# Emit D-Bus signals
458
self.PropertyChanged(dbus.String(u"enabled"),
459
dbus.Boolean(True, variant_level=1))
460
self.PropertyChanged(dbus.String(u"last_enabled"),
461
(_datetime_to_dbus(self.last_enabled,
462
variant_level=1)))
463
return r
464
465
def disable(self, signal = True):
466
oldstate = getattr(self, "enabled", False)
467
r = Client.disable(self)
468
if signal and oldstate != self.enabled:
469
# Emit D-Bus signal
470
self.PropertyChanged(dbus.String(u"enabled"),
471
dbus.Boolean(False, variant_level=1))
472
return r
1248
("/clients/" + client_object_name))
1249
DBusObjectWithProperties.__init__(self, self.bus,
1250
self.dbus_object_path)
1251
1252
def notifychangeproperty(transform_func,
1253
dbus_name, type_func=lambda x: x,
1254
variant_level=1, invalidate_only=False,
1255
_interface=_interface):
1256
""" Modify a variable so that it's a property which announces
1257
its changes to DBus.
1258
1259
transform_fun: Function that takes a value and a variant_level
1260
and transforms it to a D-Bus type.
1261
dbus_name: D-Bus name of the variable
1262
type_func: Function that transform the value before sending it
1263
to the D-Bus. Default: no transform
1264
variant_level: D-Bus variant level. Default: 1
1265
"""
1266
attrname = "_{}".format(dbus_name)
1267
def setter(self, value):
1268
if hasattr(self, "dbus_object_path"):
1269
if (not hasattr(self, attrname) or
1270
type_func(getattr(self, attrname, None))
1271
!= type_func(value)):
1272
if invalidate_only:
1273
self.PropertiesChanged(_interface,
1274
dbus.Dictionary(),
1275
dbus.Array
1276
((dbus_name,)))
1277
else:
1278
dbus_value = transform_func(type_func(value),
1279
variant_level
1280
=variant_level)
1281
self.PropertyChanged(dbus.String(dbus_name),
1282
dbus_value)
1283
self.PropertiesChanged(_interface,
1284
dbus.Dictionary({
1285
dbus.String(dbus_name):
1286
dbus_value }), dbus.Array())
1287
setattr(self, attrname, value)
1288
1289
return property(lambda self: getattr(self, attrname), setter)
1290
1291
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1292
approvals_pending = notifychangeproperty(dbus.Boolean,
1293
"ApprovalPending",
1294
type_func = bool)
1295
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1296
last_enabled = notifychangeproperty(datetime_to_dbus,
1297
"LastEnabled")
1298
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1299
type_func = lambda checker:
1300
checker is not None)
1301
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1302
"LastCheckedOK")
1303
last_checker_status = notifychangeproperty(dbus.Int16,
1304
"LastCheckerStatus")
1305
last_approval_request = notifychangeproperty(
1306
datetime_to_dbus, "LastApprovalRequest")
1307
approved_by_default = notifychangeproperty(dbus.Boolean,
1308
"ApprovedByDefault")
1309
approval_delay = notifychangeproperty(dbus.UInt64,
1310
"ApprovalDelay",
1311
type_func =
1312
lambda td: td.total_seconds()
1313
* 1000)
1314
approval_duration = notifychangeproperty(
1315
dbus.UInt64, "ApprovalDuration",
1316
type_func = lambda td: td.total_seconds() * 1000)
1317
host = notifychangeproperty(dbus.String, "Host")
1318
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1319
type_func = lambda td:
1320
td.total_seconds() * 1000)
1321
extended_timeout = notifychangeproperty(
1322
dbus.UInt64, "ExtendedTimeout",
1323
type_func = lambda td: td.total_seconds() * 1000)
1324
interval = notifychangeproperty(dbus.UInt64,
1325
"Interval",
1326
type_func =
1327
lambda td: td.total_seconds()
1328
* 1000)
1329
checker_command = notifychangeproperty(dbus.String, "Checker")
1330
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1331
invalidate_only=True)
1332
1333
del notifychangeproperty
473
1334
474
1335
def __del__(self, *args, **kwargs):
475
1336
try:
476
1337
self.remove_from_connection()
477
1338
except LookupError:
478
1339
pass
479
if hasattr(dbus.service.Object, "__del__"):
480
dbus.service.Object.__del__(self, *args, **kwargs)
1340
if hasattr(DBusObjectWithProperties, "__del__"):
1341
DBusObjectWithProperties.__del__(self, *args, **kwargs)
481
1342
Client.__del__(self, *args, **kwargs)
482
1343
483
1344
def checker_callback(self, pid, condition, command,
484
1345
*args, **kwargs):
485
1346
self.checker_callback_tag = None
486
1347
self.checker = None
487
# Emit D-Bus signal
488
self.PropertyChanged(dbus.String(u"checker_running"),
489
dbus.Boolean(False, variant_level=1))
490
1348
if os.WIFEXITED(condition):
491
1349
exitstatus = os.WEXITSTATUS(condition)
492
1350
# Emit D-Bus signal
502
1360
return Client.checker_callback(self, pid, condition, command,
503
1361
*args, **kwargs)
504
1362
505
def checked_ok(self, *args, **kwargs):
506
r = Client.checked_ok(self, *args, **kwargs)
507
# Emit D-Bus signal
508
self.PropertyChanged(
509
dbus.String(u"last_checked_ok"),
510
(_datetime_to_dbus(self.last_checked_ok,
511
variant_level=1)))
512
return r
513
514
1363
def start_checker(self, *args, **kwargs):
515
old_checker = self.checker
516
if self.checker is not None:
517
old_checker_pid = self.checker.pid
518
else:
519
old_checker_pid = None
1364
old_checker_pid = getattr(self.checker, "pid", None)
520
1365
r = Client.start_checker(self, *args, **kwargs)
521
1366
# Only if new checker process was started
522
1367
if (self.checker is not None
523
1368
and old_checker_pid != self.checker.pid):
524
1369
# Emit D-Bus signal
525
1370
self.CheckerStarted(self.current_checker_command)
526
self.PropertyChanged(
527
dbus.String("checker_running"),
528
dbus.Boolean(True, variant_level=1))
529
return r
530
531
def stop_checker(self, *args, **kwargs):
532
old_checker = getattr(self, "checker", None)
533
r = Client.stop_checker(self, *args, **kwargs)
534
if (old_checker is not None
535
and getattr(self, "checker", None) is None):
536
self.PropertyChanged(dbus.String(u"checker_running"),
537
dbus.Boolean(False, variant_level=1))
538
return r
539
540
## D-Bus methods & signals
541
_interface = u"se.bsnet.fukt.Mandos.Client"
542
543
# CheckedOK - method
544
CheckedOK = dbus.service.method(_interface)(checked_ok)
545
CheckedOK.__name__ = "CheckedOK"
1371
return r
1372
1373
def _reset_approved(self):
1374
self.approved = None
1375
return False
1376
1377
def approve(self, value=True):
1378
self.approved = value
1379
gobject.timeout_add(int(self.approval_duration.total_seconds()
1380
* 1000), self._reset_approved)
1381
self.send_changedstate()
1382
1383
## D-Bus methods, signals & properties
1384
1385
## Interfaces
1386
1387
## Signals
546
1388
547
1389
# CheckerCompleted - signal
548
1390
@dbus.service.signal(_interface, signature="nxs")
556
1398
"D-Bus signal"
557
1399
pass
558
1400
559
# GetAllProperties - method
560
@dbus.service.method(_interface, out_signature="a{sv}")
561
def GetAllProperties(self):
562
"D-Bus method"
563
return dbus.Dictionary({
564
dbus.String("name"):
565
dbus.String(self.name, variant_level=1),
566
dbus.String("fingerprint"):
567
dbus.String(self.fingerprint, variant_level=1),
568
dbus.String("host"):
569
dbus.String(self.host, variant_level=1),
570
dbus.String("created"):
571
_datetime_to_dbus(self.created, variant_level=1),
572
dbus.String("last_enabled"):
573
(_datetime_to_dbus(self.last_enabled,
574
variant_level=1)
575
if self.last_enabled is not None
576
else dbus.Boolean(False, variant_level=1)),
577
dbus.String("enabled"):
578
dbus.Boolean(self.enabled, variant_level=1),
579
dbus.String("last_checked_ok"):
580
(_datetime_to_dbus(self.last_checked_ok,
581
variant_level=1)
582
if self.last_checked_ok is not None
583
else dbus.Boolean (False, variant_level=1)),
584
dbus.String("timeout"):
585
dbus.UInt64(self.timeout_milliseconds(),
586
variant_level=1),
587
dbus.String("interval"):
588
dbus.UInt64(self.interval_milliseconds(),
589
variant_level=1),
590
dbus.String("checker"):
591
dbus.String(self.checker_command,
592
variant_level=1),
593
dbus.String("checker_running"):
594
dbus.Boolean(self.checker is not None,
595
variant_level=1),
596
dbus.String("object_path"):
597
dbus.ObjectPath(self.dbus_object_path,
598
variant_level=1)
599
}, signature="sv")
600
601
# IsStillValid - method
602
@dbus.service.method(_interface, out_signature="b")
603
def IsStillValid(self):
604
return self.still_valid()
605
606
1401
# PropertyChanged - signal
1402
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
607
1403
@dbus.service.signal(_interface, signature="sv")
608
1404
def PropertyChanged(self, property, value):
609
1405
"D-Bus signal"
610
1406
pass
611
1407
612
# ReceivedSecret - signal
1408
# GotSecret - signal
613
1409
@dbus.service.signal(_interface)
614
def ReceivedSecret(self):
615
"D-Bus signal"
1410
def GotSecret(self):
1411
"""D-Bus signal
1412
Is sent after a successful transfer of secret from the Mandos
1413
server to mandos-client
1414
"""
616
1415
pass
617
1416
618
1417
# Rejected - signal
619
@dbus.service.signal(_interface)
620
def Rejected(self):
1418
@dbus.service.signal(_interface, signature="s")
1419
def Rejected(self, reason):
621
1420
"D-Bus signal"
622
1421
pass
623
1422
624
# SetChecker - method
625
@dbus.service.method(_interface, in_signature="s")
626
def SetChecker(self, checker):
627
"D-Bus setter method"
628
self.checker_command = checker
629
# Emit D-Bus signal
630
self.PropertyChanged(dbus.String(u"checker"),
631
dbus.String(self.checker_command,
632
variant_level=1))
633
634
# SetHost - method
635
@dbus.service.method(_interface, in_signature="s")
636
def SetHost(self, host):
637
"D-Bus setter method"
638
self.host = host
639
# Emit D-Bus signal
640
self.PropertyChanged(dbus.String(u"host"),
641
dbus.String(self.host, variant_level=1))
642
643
# SetInterval - method
644
@dbus.service.method(_interface, in_signature="t")
645
def SetInterval(self, milliseconds):
646
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
647
# Emit D-Bus signal
648
self.PropertyChanged(dbus.String(u"interval"),
649
(dbus.UInt64(self.interval_milliseconds(),
650
variant_level=1)))
651
652
# SetSecret - method
653
@dbus.service.method(_interface, in_signature="ay",
654
byte_arrays=True)
655
def SetSecret(self, secret):
656
"D-Bus setter method"
657
self.secret = str(secret)
658
659
# SetTimeout - method
660
@dbus.service.method(_interface, in_signature="t")
661
def SetTimeout(self, milliseconds):
662
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
663
# Emit D-Bus signal
664
self.PropertyChanged(dbus.String(u"timeout"),
665
(dbus.UInt64(self.timeout_milliseconds(),
666
variant_level=1)))
1423
# NeedApproval - signal
1424
@dbus.service.signal(_interface, signature="tb")
1425
def NeedApproval(self, timeout, default):
1426
"D-Bus signal"
1427
return self.need_approval()
1428
1429
## Methods
1430
1431
# Approve - method
1432
@dbus.service.method(_interface, in_signature="b")
1433
def Approve(self, value):
1434
self.approve(value)
1435
1436
# CheckedOK - method
1437
@dbus.service.method(_interface)
1438
def CheckedOK(self):
1439
self.checked_ok()
667
1440
668
1441
# Enable - method
669
Enable = dbus.service.method(_interface)(enable)
670
Enable.__name__ = "Enable"
1442
@dbus.service.method(_interface)
1443
def Enable(self):
1444
"D-Bus method"
1445
self.enable()
671
1446
672
1447
# StartChecker - method
673
1448
@dbus.service.method(_interface)
682
1457
self.disable()
683
1458
684
1459
# StopChecker - method
685
StopChecker = dbus.service.method(_interface)(stop_checker)
686
StopChecker.__name__ = "StopChecker"
1460
@dbus.service.method(_interface)
1461
def StopChecker(self):
1462
self.stop_checker()
1463
1464
## Properties
1465
1466
# ApprovalPending - property
1467
@dbus_service_property(_interface, signature="b", access="read")
1468
def ApprovalPending_dbus_property(self):
1469
return dbus.Boolean(bool(self.approvals_pending))
1470
1471
# ApprovedByDefault - property
1472
@dbus_service_property(_interface, signature="b",
1473
access="readwrite")
1474
def ApprovedByDefault_dbus_property(self, value=None):
1475
if value is None: # get
1476
return dbus.Boolean(self.approved_by_default)
1477
self.approved_by_default = bool(value)
1478
1479
# ApprovalDelay - property
1480
@dbus_service_property(_interface, signature="t",
1481
access="readwrite")
1482
def ApprovalDelay_dbus_property(self, value=None):
1483
if value is None: # get
1484
return dbus.UInt64(self.approval_delay.total_seconds()
1485
* 1000)
1486
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1487
1488
# ApprovalDuration - property
1489
@dbus_service_property(_interface, signature="t",
1490
access="readwrite")
1491
def ApprovalDuration_dbus_property(self, value=None):
1492
if value is None: # get
1493
return dbus.UInt64(self.approval_duration.total_seconds()
1494
* 1000)
1495
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1496
1497
# Name - property
1498
@dbus_service_property(_interface, signature="s", access="read")
1499
def Name_dbus_property(self):
1500
return dbus.String(self.name)
1501
1502
# Fingerprint - property
1503
@dbus_service_property(_interface, signature="s", access="read")
1504
def Fingerprint_dbus_property(self):
1505
return dbus.String(self.fingerprint)
1506
1507
# Host - property
1508
@dbus_service_property(_interface, signature="s",
1509
access="readwrite")
1510
def Host_dbus_property(self, value=None):
1511
if value is None: # get
1512
return dbus.String(self.host)
1513
self.host = str(value)
1514
1515
# Created - property
1516
@dbus_service_property(_interface, signature="s", access="read")
1517
def Created_dbus_property(self):
1518
return datetime_to_dbus(self.created)
1519
1520
# LastEnabled - property
1521
@dbus_service_property(_interface, signature="s", access="read")
1522
def LastEnabled_dbus_property(self):
1523
return datetime_to_dbus(self.last_enabled)
1524
1525
# Enabled - property
1526
@dbus_service_property(_interface, signature="b",
1527
access="readwrite")
1528
def Enabled_dbus_property(self, value=None):
1529
if value is None: # get
1530
return dbus.Boolean(self.enabled)
1531
if value:
1532
self.enable()
1533
else:
1534
self.disable()
1535
1536
# LastCheckedOK - property
1537
@dbus_service_property(_interface, signature="s",
1538
access="readwrite")
1539
def LastCheckedOK_dbus_property(self, value=None):
1540
if value is not None:
1541
self.checked_ok()
1542
return
1543
return datetime_to_dbus(self.last_checked_ok)
1544
1545
# LastCheckerStatus - property
1546
@dbus_service_property(_interface, signature="n",
1547
access="read")
1548
def LastCheckerStatus_dbus_property(self):
1549
return dbus.Int16(self.last_checker_status)
1550
1551
# Expires - property
1552
@dbus_service_property(_interface, signature="s", access="read")
1553
def Expires_dbus_property(self):
1554
return datetime_to_dbus(self.expires)
1555
1556
# LastApprovalRequest - property
1557
@dbus_service_property(_interface, signature="s", access="read")
1558
def LastApprovalRequest_dbus_property(self):
1559
return datetime_to_dbus(self.last_approval_request)
1560
1561
# Timeout - property
1562
@dbus_service_property(_interface, signature="t",
1563
access="readwrite")
1564
def Timeout_dbus_property(self, value=None):
1565
if value is None: # get
1566
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1567
old_timeout = self.timeout
1568
self.timeout = datetime.timedelta(0, 0, 0, value)
1569
# Reschedule disabling
1570
if self.enabled:
1571
now = datetime.datetime.utcnow()
1572
self.expires += self.timeout - old_timeout
1573
if self.expires <= now:
1574
# The timeout has passed
1575
self.disable()
1576
else:
1577
if (getattr(self, "disable_initiator_tag", None)
1578
is None):
1579
return
1580
gobject.source_remove(self.disable_initiator_tag)
1581
self.disable_initiator_tag = (
1582
gobject.timeout_add(
1583
int((self.expires - now).total_seconds()
1584
* 1000), self.disable))
1585
1586
# ExtendedTimeout - property
1587
@dbus_service_property(_interface, signature="t",
1588
access="readwrite")
1589
def ExtendedTimeout_dbus_property(self, value=None):
1590
if value is None: # get
1591
return dbus.UInt64(self.extended_timeout.total_seconds()
1592
* 1000)
1593
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1594
1595
# Interval - property
1596
@dbus_service_property(_interface, signature="t",
1597
access="readwrite")
1598
def Interval_dbus_property(self, value=None):
1599
if value is None: # get
1600
return dbus.UInt64(self.interval.total_seconds() * 1000)
1601
self.interval = datetime.timedelta(0, 0, 0, value)
1602
if getattr(self, "checker_initiator_tag", None) is None:
1603
return
1604
if self.enabled:
1605
# Reschedule checker run
1606
gobject.source_remove(self.checker_initiator_tag)
1607
self.checker_initiator_tag = (gobject.timeout_add
1608
(value, self.start_checker))
1609
self.start_checker() # Start one now, too
1610
1611
# Checker - property
1612
@dbus_service_property(_interface, signature="s",
1613
access="readwrite")
1614
def Checker_dbus_property(self, value=None):
1615
if value is None: # get
1616
return dbus.String(self.checker_command)
1617
self.checker_command = str(value)
1618
1619
# CheckerRunning - property
1620
@dbus_service_property(_interface, signature="b",
1621
access="readwrite")
1622
def CheckerRunning_dbus_property(self, value=None):
1623
if value is None: # get
1624
return dbus.Boolean(self.checker is not None)
1625
if value:
1626
self.start_checker()
1627
else:
1628
self.stop_checker()
1629
1630
# ObjectPath - property
1631
@dbus_service_property(_interface, signature="o", access="read")
1632
def ObjectPath_dbus_property(self):
1633
return self.dbus_object_path # is already a dbus.ObjectPath
1634
1635
# Secret = property
1636
@dbus_service_property(_interface, signature="ay",
1637
access="write", byte_arrays=True)
1638
def Secret_dbus_property(self, value):
1639
self.secret = bytes(value)
687
1640
688
1641
del _interface
689
1642
690
1643
691
class ClientHandler(SocketServer.BaseRequestHandler, object):
1644
class ProxyClient(object):
1645
def __init__(self, child_pipe, fpr, address):
1646
self._pipe = child_pipe
1647
self._pipe.send(('init', fpr, address))
1648
if not self._pipe.recv():
1649
raise KeyError()
1650
1651
def __getattribute__(self, name):
1652
if name == '_pipe':
1653
return super(ProxyClient, self).__getattribute__(name)
1654
self._pipe.send(('getattr', name))
1655
data = self._pipe.recv()
1656
if data[0] == 'data':
1657
return data[1]
1658
if data[0] == 'function':
1659
def func(*args, **kwargs):
1660
self._pipe.send(('funcall', name, args, kwargs))
1661
return self._pipe.recv()[1]
1662
return func
1663
1664
def __setattr__(self, name, value):
1665
if name == '_pipe':
1666
return super(ProxyClient, self).__setattr__(name, value)
1667
self._pipe.send(('setattr', name, value))
1668
1669
1670
class ClientHandler(socketserver.BaseRequestHandler, object):
692
1671
"""A class to handle client connections.
693
1672
694
1673
Instantiated once for each connection to handle it.
695
1674
Note: This will run in its own forked process."""
696
1675
697
1676
def handle(self):
698
logger.info(u"TCP connection from: %s",
699
unicode(self.client_address))
700
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
701
# Open IPC pipe to parent process
702
with closing(os.fdopen(self.server.pipe[1], "w", 1)) as ipc:
1677
with contextlib.closing(self.server.child_pipe) as child_pipe:
1678
logger.info("TCP connection from: %s",
1679
str(self.client_address))
1680
logger.debug("Pipe FD: %d",
1681
self.server.child_pipe.fileno())
1682
703
1683
session = (gnutls.connection
704
1684
.ClientSession(self.request,
705
1685
gnutls.connection
706
1686
.X509Credentials()))
707
1687
708
line = self.request.makefile().readline()
709
logger.debug(u"Protocol version: %r", line)
710
try:
711
if int(line.strip().split()[0]) > 1:
712
raise RuntimeError
713
except (ValueError, IndexError, RuntimeError), error:
714
logger.error(u"Unknown protocol version: %s", error)
715
return
716
717
1688
# Note: gnutls.connection.X509Credentials is really a
718
1689
# generic GnuTLS certificate credentials object so long as
719
1690
# no X.509 keys are added to it. Therefore, we can use it
720
1691
# here despite using OpenPGP certificates.
721
1692
722
1693
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
723
# "+AES-256-CBC", "+SHA1",
724
# "+COMP-NULL", "+CTYPE-OPENPGP",
725
# "+DHE-DSS"))
1694
# "+AES-256-CBC", "+SHA1",
1695
# "+COMP-NULL", "+CTYPE-OPENPGP",
1696
# "+DHE-DSS"))
726
1697
# Use a fallback default, since this MUST be set.
727
1698
priority = self.server.gnutls_priority
728
1699
if priority is None:
731
1702
.gnutls_priority_set_direct(session._c_object,
732
1703
priority, None))
733
1704
1705
# Start communication using the Mandos protocol
1706
# Get protocol number
1707
line = self.request.makefile().readline()
1708
logger.debug("Protocol version: %r", line)
1709
try:
1710
if int(line.strip().split()[0]) > 1:
1711
raise RuntimeError(line)
1712
except (ValueError, IndexError, RuntimeError) as error:
1713
logger.error("Unknown protocol version: %s", error)
1714
return
1715
1716
# Start GnuTLS connection
734
1717
try:
735
1718
session.handshake()
736
except gnutls.errors.GNUTLSError, error:
737
logger.warning(u"Handshake failed: %s", error)
1719
except gnutls.errors.GNUTLSError as error:
1720
logger.warning("Handshake failed: %s", error)
738
1721
# Do not run session.bye() here: the session is not
739
1722
# established. Just abandon the request.
740
1723
return
741
logger.debug(u"Handshake succeeded")
1724
logger.debug("Handshake succeeded")
1725
1726
approval_required = False
742
1727
try:
743
fpr = self.fingerprint(self.peer_certificate(session))
744
except (TypeError, gnutls.errors.GNUTLSError), error:
745
logger.warning(u"Bad certificate: %s", error)
746
session.bye()
747
return
748
logger.debug(u"Fingerprint: %s", fpr)
1728
try:
1729
fpr = self.fingerprint(self.peer_certificate
1730
(session))
1731
except (TypeError,
1732
gnutls.errors.GNUTLSError) as error:
1733
logger.warning("Bad certificate: %s", error)
1734
return
1735
logger.debug("Fingerprint: %s", fpr)
1736
1737
try:
1738
client = ProxyClient(child_pipe, fpr,
1739
self.client_address)
1740
except KeyError:
1741
return
1742
1743
if client.approval_delay:
1744
delay = client.approval_delay
1745
client.approvals_pending += 1
1746
approval_required = True
1747
1748
while True:
1749
if not client.enabled:
1750
logger.info("Client %s is disabled",
1751
client.name)
1752
if self.server.use_dbus:
1753
# Emit D-Bus signal
1754
client.Rejected("Disabled")
1755
return
1756
1757
if client.approved or not client.approval_delay:
1758
#We are approved or approval is disabled
1759
break
1760
elif client.approved is None:
1761
logger.info("Client %s needs approval",
1762
client.name)
1763
if self.server.use_dbus:
1764
# Emit D-Bus signal
1765
client.NeedApproval(
1766
client.approval_delay.total_seconds()
1767
* 1000, client.approved_by_default)
1768
else:
1769
logger.warning("Client %s was not approved",
1770
client.name)
1771
if self.server.use_dbus:
1772
# Emit D-Bus signal
1773
client.Rejected("Denied")
1774
return
1775
1776
#wait until timeout or approved
1777
time = datetime.datetime.now()
1778
client.changedstate.acquire()
1779
client.changedstate.wait(delay.total_seconds())
1780
client.changedstate.release()
1781
time2 = datetime.datetime.now()
1782
if (time2 - time) >= delay:
1783
if not client.approved_by_default:
1784
logger.warning("Client %s timed out while"
1785
" waiting for approval",
1786
client.name)
1787
if self.server.use_dbus:
1788
# Emit D-Bus signal
1789
client.Rejected("Approval timed out")
1790
return
1791
else:
1792
break
1793
else:
1794
delay -= time2 - time
1795
1796
sent_size = 0
1797
while sent_size < len(client.secret):
1798
try:
1799
sent = session.send(client.secret[sent_size:])
1800
except gnutls.errors.GNUTLSError as error:
1801
logger.warning("gnutls send failed",
1802
exc_info=error)
1803
return
1804
logger.debug("Sent: %d, remaining: %d",
1805
sent, len(client.secret)
1806
- (sent_size + sent))
1807
sent_size += sent
1808
1809
logger.info("Sending secret to %s", client.name)
1810
# bump the timeout using extended_timeout
1811
client.bump_timeout(client.extended_timeout)
1812
if self.server.use_dbus:
1813
# Emit D-Bus signal
1814
client.GotSecret()
749
1815
750
for c in self.server.clients:
751
if c.fingerprint == fpr:
752
client = c
753
break
754
else:
755
ipc.write("NOTFOUND %s\n" % fpr)
756
session.bye()
757
return
758
# Have to check if client.still_valid(), since it is
759
# possible that the client timed out while establishing
760
# the GnuTLS session.
761
if not client.still_valid():
762
ipc.write("INVALID %s\n" % client.name)
763
session.bye()
764
return
765
ipc.write("SENDING %s\n" % client.name)
766
sent_size = 0
767
while sent_size < len(client.secret):
768
sent = session.send(client.secret[sent_size:])
769
logger.debug(u"Sent: %d, remaining: %d",
770
sent, len(client.secret)
771
- (sent_size + sent))
772
sent_size += sent
773
session.bye()
1816
finally:
1817
if approval_required:
1818
client.approvals_pending -= 1
1819
try:
1820
session.bye()
1821
except gnutls.errors.GNUTLSError as error:
1822
logger.warning("GnuTLS bye failed",
1823
exc_info=error)
774
1824
775
1825
@staticmethod
776
1826
def peer_certificate(session):
832
1882
# Convert the buffer to a Python bytestring
833
1883
fpr = ctypes.string_at(buf, buf_len.value)
834
1884
# Convert the bytestring to hexadecimal notation
835
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1885
hex_fpr = binascii.hexlify(fpr).upper()
836
1886
return hex_fpr
837
1887
838
1888
839
class ForkingMixInWithPipe(SocketServer.ForkingMixIn, object):
840
"""Like SocketServer.ForkingMixIn, but also pass a pipe.
1889
class MultiprocessingMixIn(object):
1890
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1891
def sub_process_main(self, request, address):
1892
try:
1893
self.finish_request(request, address)
1894
except Exception:
1895
self.handle_error(request, address)
1896
self.close_request(request)
841
1897
842
Assumes a gobject.MainLoop event loop.
843
"""
1898
def process_request(self, request, address):
1899
"""Start a new process to process the request."""
1900
proc = multiprocessing.Process(target = self.sub_process_main,
1901
args = (request, address))
1902
proc.start()
1903
return proc
1904
1905
1906
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1907
""" adds a pipe to the MixIn """
844
1908
def process_request(self, request, client_address):
845
1909
"""Overrides and wraps the original process_request().
846
1910
847
This function creates a new pipe in self.pipe
1911
This function creates a new pipe in self.pipe
848
1912
"""
849
self.pipe = os.pipe()
850
super(ForkingMixInWithPipe,
851
self).process_request(request, client_address)
852
os.close(self.pipe[1]) # close write end
853
# Call "handle_ipc" for both data and EOF events
854
gobject.io_add_watch(self.pipe[0],
855
gobject.IO_IN | gobject.IO_HUP,
856
self.handle_ipc)
857
def handle_ipc(source, condition):
1913
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1914
1915
proc = MultiprocessingMixIn.process_request(self, request,
1916
client_address)
1917
self.child_pipe.close()
1918
self.add_pipe(parent_pipe, proc)
1919
1920
def add_pipe(self, parent_pipe, proc):
858
1921
"""Dummy function; override as necessary"""
859
os.close(source)
860
return False
861
862
863
class IPv6_TCPServer(ForkingMixInWithPipe,
864
SocketServer.TCPServer, object):
1922
raise NotImplementedError()
1923
1924
1925
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1926
socketserver.TCPServer, object):
865
1927
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
866
1928
867
1929
Attributes:
868
1930
enabled: Boolean; whether this server is activated yet
869
1931
interface: None or a network interface name (string)
870
1932
use_ipv6: Boolean; to use IPv6 or not
871
----
872
clients: Set() of Client objects
873
gnutls_priority GnuTLS priority string
874
use_dbus: Boolean; to emit D-Bus signals or not
875
1933
"""
876
1934
def __init__(self, server_address, RequestHandlerClass,
877
interface=None, use_ipv6=True, clients=None,
878
gnutls_priority=None, use_dbus=True):
879
self.enabled = False
1935
interface=None, use_ipv6=True, socketfd=None):
1936
"""If socketfd is set, use that file descriptor instead of
1937
creating a new one with socket.socket().
1938
"""
880
1939
self.interface = interface
881
1940
if use_ipv6:
882
1941
self.address_family = socket.AF_INET6
883
self.clients = clients
884
self.use_dbus = use_dbus
885
self.gnutls_priority = gnutls_priority
886
SocketServer.TCPServer.__init__(self, server_address,
1942
if socketfd is not None:
1943
# Save the file descriptor
1944
self.socketfd = socketfd
1945
# Save the original socket.socket() function
1946
self.socket_socket = socket.socket
1947
# To implement --socket, we monkey patch socket.socket.
1948
#
1949
# (When socketserver.TCPServer is a new-style class, we
1950
# could make self.socket into a property instead of monkey
1951
# patching socket.socket.)
1952
#
1953
# Create a one-time-only replacement for socket.socket()
1954
@functools.wraps(socket.socket)
1955
def socket_wrapper(*args, **kwargs):
1956
# Restore original function so subsequent calls are
1957
# not affected.
1958
socket.socket = self.socket_socket
1959
del self.socket_socket
1960
# This time only, return a new socket object from the
1961
# saved file descriptor.
1962
return socket.fromfd(self.socketfd, *args, **kwargs)
1963
# Replace socket.socket() function with wrapper
1964
socket.socket = socket_wrapper
1965
# The socketserver.TCPServer.__init__ will call
1966
# socket.socket(), which might be our replacement,
1967
# socket_wrapper(), if socketfd was set.
1968
socketserver.TCPServer.__init__(self, server_address,
887
1969
RequestHandlerClass)
1970
888
1971
def server_bind(self):
889
1972
"""This overrides the normal server_bind() function
890
1973
to bind to an interface if one was specified, and also NOT to
891
1974
bind to an address or port if they were not specified."""
892
1975
if self.interface is not None:
893
try:
894
self.socket.setsockopt(socket.SOL_SOCKET,
895
SO_BINDTODEVICE,
896
self.interface + '\0')
897
except socket.error, error:
898
if error[0] == errno.EPERM:
899
logger.error(u"No permission to"
900
u" bind to interface %s",
901
self.interface)
902
else:
903
raise
1976
if SO_BINDTODEVICE is None:
1977
logger.error("SO_BINDTODEVICE does not exist;"
1978
" cannot bind to interface %s",
1979
self.interface)
1980
else:
1981
try:
1982
self.socket.setsockopt(socket.SOL_SOCKET,
1983
SO_BINDTODEVICE,
1984
(self.interface + "\0")
1985
.encode("utf-8"))
1986
except socket.error as error:
1987
if error.errno == errno.EPERM:
1988
logger.error("No permission to bind to"
1989
" interface %s", self.interface)
1990
elif error.errno == errno.ENOPROTOOPT:
1991
logger.error("SO_BINDTODEVICE not available;"
1992
" cannot bind to interface %s",
1993
self.interface)
1994
elif error.errno == errno.ENODEV:
1995
logger.error("Interface %s does not exist,"
1996
" cannot bind", self.interface)
1997
else:
1998
raise
904
1999
# Only bind(2) the socket if we really need to.
905
2000
if self.server_address[0] or self.server_address[1]:
906
2001
if not self.server_address[0]:
907
2002
if self.address_family == socket.AF_INET6:
908
2003
any_address = "::" # in6addr_any
909
2004
else:
910
any_address = socket.INADDR_ANY
2005
any_address = "0.0.0.0" # INADDR_ANY
911
2006
self.server_address = (any_address,
912
2007
self.server_address[1])
913
2008
elif not self.server_address[1]:
919
2014
# 0, # flowinfo
920
2015
# if_nametoindex
921
2016
# (self.interface))
922
return SocketServer.TCPServer.server_bind(self)
2017
return socketserver.TCPServer.server_bind(self)
2018
2019
2020
class MandosServer(IPv6_TCPServer):
2021
"""Mandos server.
2022
2023
Attributes:
2024
clients: set of Client objects
2025
gnutls_priority GnuTLS priority string
2026
use_dbus: Boolean; to emit D-Bus signals or not
2027
2028
Assumes a gobject.MainLoop event loop.
2029
"""
2030
def __init__(self, server_address, RequestHandlerClass,
2031
interface=None, use_ipv6=True, clients=None,
2032
gnutls_priority=None, use_dbus=True, socketfd=None):
2033
self.enabled = False
2034
self.clients = clients
2035
if self.clients is None:
2036
self.clients = {}
2037
self.use_dbus = use_dbus
2038
self.gnutls_priority = gnutls_priority
2039
IPv6_TCPServer.__init__(self, server_address,
2040
RequestHandlerClass,
2041
interface = interface,
2042
use_ipv6 = use_ipv6,
2043
socketfd = socketfd)
923
2044
def server_activate(self):
924
2045
if self.enabled:
925
return SocketServer.TCPServer.server_activate(self)
2046
return socketserver.TCPServer.server_activate(self)
2047
926
2048
def enable(self):
927
2049
self.enabled = True
928
def handle_ipc(self, source, condition, file_objects={}):
929
condition_names = {
930
gobject.IO_IN: "IN", # There is data to read.
931
gobject.IO_OUT: "OUT", # Data can be written (without
932
# blocking).
933
gobject.IO_PRI: "PRI", # There is urgent data to read.
934
gobject.IO_ERR: "ERR", # Error condition.
935
gobject.IO_HUP: "HUP" # Hung up (the connection has been
936
# broken, usually for pipes and
937
# sockets).
938
}
939
conditions_string = ' | '.join(name
940
for cond, name in
941
condition_names.iteritems()
942
if cond & condition)
943
logger.debug("Handling IPC: FD = %d, condition = %s", source,
944
conditions_string)
945
946
# Turn the pipe file descriptor into a Python file object
947
if source not in file_objects:
948
file_objects[source] = os.fdopen(source, "r", 1)
949
950
# Read a line from the file object
951
cmdline = file_objects[source].readline()
952
if not cmdline: # Empty line means end of file
953
# close the IPC pipe
954
file_objects[source].close()
955
del file_objects[source]
956
957
# Stop calling this function
958
return False
959
960
logger.debug("IPC command: %r", cmdline)
961
962
# Parse and act on command
963
cmd, args = cmdline.rstrip("\r\n").split(None, 1)
964
965
if cmd == "NOTFOUND":
966
logger.warning(u"Client not found for fingerprint: %s",
967
args)
968
if self.use_dbus:
969
# Emit D-Bus signal
970
mandos_dbus_service.ClientNotFound(args)
971
elif cmd == "INVALID":
972
for client in self.clients:
973
if client.name == args:
974
logger.warning(u"Client %s is invalid", args)
975
if self.use_dbus:
976
# Emit D-Bus signal
977
client.Rejected()
978
break
979
else:
980
logger.error(u"Unknown client %s is invalid", args)
981
elif cmd == "SENDING":
982
for client in self.clients:
983
if client.name == args:
984
logger.info(u"Sending secret to %s", client.name)
985
client.checked_ok()
986
if self.use_dbus:
987
# Emit D-Bus signal
988
client.ReceivedSecret()
989
break
990
else:
991
logger.error(u"Sending secret to unknown client %s",
992
args)
2050
2051
def add_pipe(self, parent_pipe, proc):
2052
# Call "handle_ipc" for both data and EOF events
2053
gobject.io_add_watch(parent_pipe.fileno(),
2054
gobject.IO_IN | gobject.IO_HUP,
2055
functools.partial(self.handle_ipc,
2056
parent_pipe =
2057
parent_pipe,
2058
proc = proc))
2059
2060
def handle_ipc(self, source, condition, parent_pipe=None,
2061
proc = None, client_object=None):
2062
# error, or the other end of multiprocessing.Pipe has closed
2063
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2064
# Wait for other process to exit
2065
proc.join()
2066
return False
2067
2068
# Read a request from the child
2069
request = parent_pipe.recv()
2070
command = request[0]
2071
2072
if command == 'init':
2073
fpr = request[1]
2074
address = request[2]
2075
2076
for c in self.clients.itervalues():
2077
if c.fingerprint == fpr:
2078
client = c
2079
break
2080
else:
2081
logger.info("Client not found for fingerprint: %s, ad"
2082
"dress: %s", fpr, address)
2083
if self.use_dbus:
2084
# Emit D-Bus signal
2085
mandos_dbus_service.ClientNotFound(fpr,
2086
address[0])
2087
parent_pipe.send(False)
2088
return False
2089
2090
gobject.io_add_watch(parent_pipe.fileno(),
2091
gobject.IO_IN | gobject.IO_HUP,
2092
functools.partial(self.handle_ipc,
2093
parent_pipe =
2094
parent_pipe,
2095
proc = proc,
2096
client_object =
2097
client))
2098
parent_pipe.send(True)
2099
# remove the old hook in favor of the new above hook on
2100
# same fileno
2101
return False
2102
if command == 'funcall':
2103
funcname = request[1]
2104
args = request[2]
2105
kwargs = request[3]
2106
2107
parent_pipe.send(('data', getattr(client_object,
2108
funcname)(*args,
2109
**kwargs)))
2110
2111
if command == 'getattr':
2112
attrname = request[1]
2113
if callable(client_object.__getattribute__(attrname)):
2114
parent_pipe.send(('function',))
2115
else:
2116
parent_pipe.send(('data', client_object
2117
.__getattribute__(attrname)))
2118
2119
if command == 'setattr':
2120
attrname = request[1]
2121
value = request[2]
2122
setattr(client_object, attrname, value)
2123
2124
return True
2125
2126
2127
def rfc3339_duration_to_delta(duration):
2128
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2129
2130
>>> rfc3339_duration_to_delta("P7D")
2131
datetime.timedelta(7)
2132
>>> rfc3339_duration_to_delta("PT60S")
2133
datetime.timedelta(0, 60)
2134
>>> rfc3339_duration_to_delta("PT60M")
2135
datetime.timedelta(0, 3600)
2136
>>> rfc3339_duration_to_delta("PT24H")
2137
datetime.timedelta(1)
2138
>>> rfc3339_duration_to_delta("P1W")
2139
datetime.timedelta(7)
2140
>>> rfc3339_duration_to_delta("PT5M30S")
2141
datetime.timedelta(0, 330)
2142
>>> rfc3339_duration_to_delta("P1DT3M20S")
2143
datetime.timedelta(1, 200)
2144
"""
2145
2146
# Parsing an RFC 3339 duration with regular expressions is not
2147
# possible - there would have to be multiple places for the same
2148
# values, like seconds. The current code, while more esoteric, is
2149
# cleaner without depending on a parsing library. If Python had a
2150
# built-in library for parsing we would use it, but we'd like to
2151
# avoid excessive use of external libraries.
2152
2153
# New type for defining tokens, syntax, and semantics all-in-one
2154
Token = collections.namedtuple("Token",
2155
("regexp", # To match token; if
2156
# "value" is not None,
2157
# must have a "group"
2158
# containing digits
2159
"value", # datetime.timedelta or
2160
# None
2161
"followers")) # Tokens valid after
2162
# this token
2163
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2164
# the "duration" ABNF definition in RFC 3339, Appendix A.
2165
token_end = Token(re.compile(r"$"), None, frozenset())
2166
token_second = Token(re.compile(r"(\d+)S"),
2167
datetime.timedelta(seconds=1),
2168
frozenset((token_end,)))
2169
token_minute = Token(re.compile(r"(\d+)M"),
2170
datetime.timedelta(minutes=1),
2171
frozenset((token_second, token_end)))
2172
token_hour = Token(re.compile(r"(\d+)H"),
2173
datetime.timedelta(hours=1),
2174
frozenset((token_minute, token_end)))
2175
token_time = Token(re.compile(r"T"),
2176
None,
2177
frozenset((token_hour, token_minute,
2178
token_second)))
2179
token_day = Token(re.compile(r"(\d+)D"),
2180
datetime.timedelta(days=1),
2181
frozenset((token_time, token_end)))
2182
token_month = Token(re.compile(r"(\d+)M"),
2183
datetime.timedelta(weeks=4),
2184
frozenset((token_day, token_end)))
2185
token_year = Token(re.compile(r"(\d+)Y"),
2186
datetime.timedelta(weeks=52),
2187
frozenset((token_month, token_end)))
2188
token_week = Token(re.compile(r"(\d+)W"),
2189
datetime.timedelta(weeks=1),
2190
frozenset((token_end,)))
2191
token_duration = Token(re.compile(r"P"), None,
2192
frozenset((token_year, token_month,
2193
token_day, token_time,
2194
token_week)))
2195
# Define starting values
2196
value = datetime.timedelta() # Value so far
2197
found_token = None
2198
followers = frozenset((token_duration,)) # Following valid tokens
2199
s = duration # String left to parse
2200
# Loop until end token is found
2201
while found_token is not token_end:
2202
# Search for any currently valid tokens
2203
for token in followers:
2204
match = token.regexp.match(s)
2205
if match is not None:
2206
# Token found
2207
if token.value is not None:
2208
# Value found, parse digits
2209
factor = int(match.group(1), 10)
2210
# Add to value so far
2211
value += factor * token.value
2212
# Strip token from string
2213
s = token.regexp.sub("", s, 1)
2214
# Go to found token
2215
found_token = token
2216
# Set valid next tokens
2217
followers = found_token.followers
2218
break
993
2219
else:
994
logger.error("Unknown IPC command: %r", cmdline)
995
996
# Keep calling this function
997
return True
2220
# No currently valid tokens were found
2221
raise ValueError("Invalid RFC 3339 duration")
2222
# End token found
2223
return value
998
2224
999
2225
1000
2226
def string_to_delta(interval):
1008
2234
datetime.timedelta(0, 3600)
1009
2235
>>> string_to_delta('24h')
1010
2236
datetime.timedelta(1)
1011
>>> string_to_delta(u'1w')
2237
>>> string_to_delta('1w')
1012
2238
datetime.timedelta(7)
1013
2239
>>> string_to_delta('5m 30s')
1014
2240
datetime.timedelta(0, 330)
1015
2241
"""
2242
2243
try:
2244
return rfc3339_duration_to_delta(interval)
2245
except ValueError:
2246
pass
2247
1016
2248
timevalue = datetime.timedelta(0)
1017
2249
for s in interval.split():
1018
2250
try:
1019
suffix = unicode(s[-1])
2251
suffix = s[-1]
1020
2252
value = int(s[:-1])
1021
if suffix == u"d":
2253
if suffix == "d":
1022
2254
delta = datetime.timedelta(value)
1023
elif suffix == u"s":
2255
elif suffix == "s":
1024
2256
delta = datetime.timedelta(0, value)
1025
elif suffix == u"m":
2257
elif suffix == "m":
1026
2258
delta = datetime.timedelta(0, 0, 0, 0, value)
1027
elif suffix == u"h":
2259
elif suffix == "h":
1028
2260
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1029
elif suffix == u"w":
2261
elif suffix == "w":
1030
2262
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1031
2263
else:
1032
raise ValueError
1033
except (ValueError, IndexError):
1034
raise ValueError
2264
raise ValueError("Unknown suffix {!r}"
2265
.format(suffix))
2266
except IndexError as e:
2267
raise ValueError(*(e.args))
1035
2268
timevalue += delta
1036
2269
return timevalue
1037
2270
1038
2271
1039
def server_state_changed(state):
1040
"""Derived from the Avahi example code"""
1041
if state == avahi.SERVER_COLLISION:
1042
logger.error(u"Zeroconf server name collision")
1043
service.remove()
1044
elif state == avahi.SERVER_RUNNING:
1045
service.add()
1046
1047
1048
def entry_group_state_changed(state, error):
1049
"""Derived from the Avahi example code"""
1050
logger.debug(u"Avahi state change: %i", state)
1051
1052
if state == avahi.ENTRY_GROUP_ESTABLISHED:
1053
logger.debug(u"Zeroconf service established.")
1054
elif state == avahi.ENTRY_GROUP_COLLISION:
1055
logger.warning(u"Zeroconf service name collision.")
1056
service.rename()
1057
elif state == avahi.ENTRY_GROUP_FAILURE:
1058
logger.critical(u"Avahi: Error in group state changed %s",
1059
unicode(error))
1060
raise AvahiGroupError(u"State changed: %s" % unicode(error))
1061
1062
def if_nametoindex(interface):
1063
"""Call the C function if_nametoindex(), or equivalent"""
1064
global if_nametoindex
1065
try:
1066
if_nametoindex = (ctypes.cdll.LoadLibrary
1067
(ctypes.util.find_library("c"))
1068
.if_nametoindex)
1069
except (OSError, AttributeError):
1070
if "struct" not in sys.modules:
1071
import struct
1072
if "fcntl" not in sys.modules:
1073
import fcntl
1074
def if_nametoindex(interface):
1075
"Get an interface index the hard way, i.e. using fcntl()"
1076
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1077
with closing(socket.socket()) as s:
1078
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1079
struct.pack("16s16x", interface))
1080
interface_index = struct.unpack("I", ifreq[16:20])[0]
1081
return interface_index
1082
return if_nametoindex(interface)
1083
1084
1085
2272
def daemon(nochdir = False, noclose = False):
1086
2273
"""See daemon(3). Standard BSD Unix function.
1087
2274
1095
2282
sys.exit()
1096
2283
if not noclose:
1097
2284
# Close all standard open file descriptors
1098
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2285
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1099
2286
if not stat.S_ISCHR(os.fstat(null).st_mode):
1100
raise OSError(errno.ENODEV,
1101
"/dev/null not a character device")
2287
raise OSError(errno.ENODEV, "{} not a character device"
2288
.format(os.devnull))
1102
2289
os.dup2(null, sys.stdin.fileno())
1103
2290
os.dup2(null, sys.stdout.fileno())
1104
2291
os.dup2(null, sys.stderr.fileno())
1108
2295
1109
2296
def main():
1110
2297
1111
######################################################################
2298
##################################################################
1112
2299
# Parsing of options, both command line and config file
1113
2300
1114
parser = optparse.OptionParser(version = "%%prog %s" % version)
1115
parser.add_option("-i", "--interface", type="string",
1116
metavar="IF", help="Bind to interface IF")
1117
parser.add_option("-a", "--address", type="string",
1118
help="Address to listen for requests on")
1119
parser.add_option("-p", "--port", type="int",
1120
help="Port number to receive requests on")
1121
parser.add_option("--check", action="store_true",
1122
help="Run self-test")
1123
parser.add_option("--debug", action="store_true",
1124
help="Debug mode; run in foreground and log to"
1125
" terminal")
1126
parser.add_option("--priority", type="string", help="GnuTLS"
1127
" priority string (see GnuTLS documentation)")
1128
parser.add_option("--servicename", type="string", metavar="NAME",
1129
help="Zeroconf service name")
1130
parser.add_option("--configdir", type="string",
1131
default="/etc/mandos", metavar="DIR",
1132
help="Directory to search for configuration"
1133
" files")
1134
parser.add_option("--no-dbus", action="store_false",
1135
dest="use_dbus",
1136
help="Do not provide D-Bus system bus"
1137
" interface")
1138
parser.add_option("--no-ipv6", action="store_false",
1139
dest="use_ipv6", help="Do not use IPv6")
1140
options = parser.parse_args()[0]
2301
parser = argparse.ArgumentParser()
2302
parser.add_argument("-v", "--version", action="version",
2303
version = "%(prog)s {}".format(version),
2304
help="show version number and exit")
2305
parser.add_argument("-i", "--interface", metavar="IF",
2306
help="Bind to interface IF")
2307
parser.add_argument("-a", "--address",
2308
help="Address to listen for requests on")
2309
parser.add_argument("-p", "--port", type=int,
2310
help="Port number to receive requests on")
2311
parser.add_argument("--check", action="store_true",
2312
help="Run self-test")
2313
parser.add_argument("--debug", action="store_true",
2314
help="Debug mode; run in foreground and log"
2315
" to terminal", default=None)
2316
parser.add_argument("--debuglevel", metavar="LEVEL",
2317
help="Debug level for stdout output")
2318
parser.add_argument("--priority", help="GnuTLS"
2319
" priority string (see GnuTLS documentation)")
2320
parser.add_argument("--servicename",
2321
metavar="NAME", help="Zeroconf service name")
2322
parser.add_argument("--configdir",
2323
default="/etc/mandos", metavar="DIR",
2324
help="Directory to search for configuration"
2325
" files")
2326
parser.add_argument("--no-dbus", action="store_false",
2327
dest="use_dbus", help="Do not provide D-Bus"
2328
" system bus interface", default=None)
2329
parser.add_argument("--no-ipv6", action="store_false",
2330
dest="use_ipv6", help="Do not use IPv6",
2331
default=None)
2332
parser.add_argument("--no-restore", action="store_false",
2333
dest="restore", help="Do not restore stored"
2334
" state", default=None)
2335
parser.add_argument("--socket", type=int,
2336
help="Specify a file descriptor to a network"
2337
" socket to use instead of creating one")
2338
parser.add_argument("--statedir", metavar="DIR",
2339
help="Directory to save/restore state in")
2340
parser.add_argument("--foreground", action="store_true",
2341
help="Run in foreground", default=None)
2342
parser.add_argument("--no-zeroconf", action="store_false",
2343
dest="zeroconf", help="Do not use Zeroconf",
2344
default=None)
2345
2346
options = parser.parse_args()
1141
2347
1142
2348
if options.check:
1143
2349
import doctest
1144
doctest.testmod()
1145
sys.exit()
2350
fail_count, test_count = doctest.testmod()
2351
sys.exit(os.EX_OK if fail_count == 0 else 1)
1146
2352
1147
2353
# Default values for config file for server-global settings
1148
2354
server_defaults = { "interface": "",
1150
2356
"port": "",
1151
2357
"debug": "False",
1152
2358
"priority":
1153
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2359
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2360
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1154
2361
"servicename": "Mandos",
1155
2362
"use_dbus": "True",
1156
2363
"use_ipv6": "True",
2364
"debuglevel": "",
2365
"restore": "True",
2366
"socket": "",
2367
"statedir": "/var/lib/mandos",
2368
"foreground": "False",
2369
"zeroconf": "True",
1157
2370
}
1158
2371
1159
2372
# Parse config file for server-global settings
1160
server_config = ConfigParser.SafeConfigParser(server_defaults)
2373
server_config = configparser.SafeConfigParser(server_defaults)
1161
2374
del server_defaults
1162
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2375
server_config.read(os.path.join(options.configdir,
2376
"mandos.conf"))
1163
2377
# Convert the SafeConfigParser object to a dict
1164
2378
server_settings = server_config.defaults()
1165
2379
# Use the appropriate methods on the non-string config options
1166
server_settings["debug"] = server_config.getboolean("DEFAULT",
1167
"debug")
1168
server_settings["use_dbus"] = server_config.getboolean("DEFAULT",
1169
"use_dbus")
1170
server_settings["use_ipv6"] = server_config.getboolean("DEFAULT",
1171
"use_ipv6")
2380
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2381
server_settings[option] = server_config.getboolean("DEFAULT",
2382
option)
1172
2383
if server_settings["port"]:
1173
2384
server_settings["port"] = server_config.getint("DEFAULT",
1174
2385
"port")
2386
if server_settings["socket"]:
2387
server_settings["socket"] = server_config.getint("DEFAULT",
2388
"socket")
2389
# Later, stdin will, and stdout and stderr might, be dup'ed
2390
# over with an opened os.devnull. But we don't want this to
2391
# happen with a supplied network socket.
2392
if 0 <= server_settings["socket"] <= 2:
2393
server_settings["socket"] = os.dup(server_settings
2394
["socket"])
1175
2395
del server_config
1176
2396
1177
2397
# Override the settings from the config file with command line
1178
2398
# options, if set.
1179
2399
for option in ("interface", "address", "port", "debug",
1180
2400
"priority", "servicename", "configdir",
1181
"use_dbus", "use_ipv6"):
2401
"use_dbus", "use_ipv6", "debuglevel", "restore",
2402
"statedir", "socket", "foreground", "zeroconf"):
1182
2403
value = getattr(options, option)
1183
2404
if value is not None:
1184
2405
server_settings[option] = value
1185
2406
del options
2407
# Force all strings to be unicode
2408
for option in server_settings.keys():
2409
if isinstance(server_settings[option], bytes):
2410
server_settings[option] = (server_settings[option]
2411
.decode("utf-8"))
2412
# Force all boolean options to be boolean
2413
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2414
"foreground", "zeroconf"):
2415
server_settings[option] = bool(server_settings[option])
2416
# Debug implies foreground
2417
if server_settings["debug"]:
2418
server_settings["foreground"] = True
1186
2419
# Now we have our good server settings in "server_settings"
1187
2420
1188
2421
##################################################################
1189
2422
2423
if (not server_settings["zeroconf"] and
2424
not (server_settings["port"]
2425
or server_settings["socket"] != "")):
2426
parser.error("Needs port or socket to work without"
2427
" Zeroconf")
2428
1190
2429
# For convenience
1191
2430
debug = server_settings["debug"]
2431
debuglevel = server_settings["debuglevel"]
1192
2432
use_dbus = server_settings["use_dbus"]
1193
2433
use_ipv6 = server_settings["use_ipv6"]
2434
stored_state_path = os.path.join(server_settings["statedir"],
2435
stored_state_file)
2436
foreground = server_settings["foreground"]
2437
zeroconf = server_settings["zeroconf"]
1194
2438
1195
if not debug:
1196
syslogger.setLevel(logging.WARNING)
1197
console.setLevel(logging.WARNING)
2439
if debug:
2440
initlogger(debug, logging.DEBUG)
2441
else:
2442
if not debuglevel:
2443
initlogger(debug)
2444
else:
2445
level = getattr(logging, debuglevel.upper())
2446
initlogger(debug, level)
1198
2447
1199
2448
if server_settings["servicename"] != "Mandos":
1200
2449
syslogger.setFormatter(logging.Formatter
1201
('Mandos (%s) [%%(process)d]:'
1202
' %%(levelname)s: %%(message)s'
1203
% server_settings["servicename"]))
2450
('Mandos ({}) [%(process)d]:'
2451
' %(levelname)s: %(message)s'
2452
.format(server_settings
2453
["servicename"])))
1204
2454
1205
2455
# Parse config file with clients
1206
client_defaults = { "timeout": "1h",
1207
"interval": "5m",
1208
"checker": "fping -q -- %%(host)s",
1209
"host": "",
1210
}
1211
client_config = ConfigParser.SafeConfigParser(client_defaults)
2456
client_config = configparser.SafeConfigParser(Client
2457
.client_defaults)
1212
2458
client_config.read(os.path.join(server_settings["configdir"],
1213
2459
"clients.conf"))
1214
2460
1215
2461
global mandos_dbus_service
1216
2462
mandos_dbus_service = None
1217
2463
1218
clients = Set()
1219
tcp_server = IPv6_TCPServer((server_settings["address"],
1220
server_settings["port"]),
1221
ClientHandler,
1222
interface=
1223
server_settings["interface"],
1224
use_ipv6=use_ipv6,
1225
clients=clients,
1226
gnutls_priority=
1227
server_settings["priority"],
1228
use_dbus=use_dbus)
1229
pidfilename = "/var/run/mandos.pid"
1230
try:
1231
pidfile = open(pidfilename, "w")
1232
except IOError:
1233
logger.error("Could not open file %r", pidfilename)
2464
socketfd = None
2465
if server_settings["socket"] != "":
2466
socketfd = server_settings["socket"]
2467
tcp_server = MandosServer((server_settings["address"],
2468
server_settings["port"]),
2469
ClientHandler,
2470
interface=(server_settings["interface"]
2471
or None),
2472
use_ipv6=use_ipv6,
2473
gnutls_priority=
2474
server_settings["priority"],
2475
use_dbus=use_dbus,
2476
socketfd=socketfd)
2477
if not foreground:
2478
pidfilename = "/run/mandos.pid"
2479
if not os.path.isdir("/run/."):
2480
pidfilename = "/var/run/mandos.pid"
2481
pidfile = None
2482
try:
2483
pidfile = open(pidfilename, "w")
2484
except IOError as e:
2485
logger.error("Could not open file %r", pidfilename,
2486
exc_info=e)
1234
2487
1235
try:
1236
uid = pwd.getpwnam("_mandos").pw_uid
1237
gid = pwd.getpwnam("_mandos").pw_gid
1238
except KeyError:
2488
for name in ("_mandos", "mandos", "nobody"):
1239
2489
try:
1240
uid = pwd.getpwnam("mandos").pw_uid
1241
gid = pwd.getpwnam("mandos").pw_gid
2490
uid = pwd.getpwnam(name).pw_uid
2491
gid = pwd.getpwnam(name).pw_gid
2492
break
1242
2493
except KeyError:
1243
try:
1244
uid = pwd.getpwnam("nobody").pw_uid
1245
gid = pwd.getpwnam("nogroup").pw_gid
1246
except KeyError:
1247
uid = 65534
1248
gid = 65534
2494
continue
2495
else:
2496
uid = 65534
2497
gid = 65534
1249
2498
try:
1250
2499
os.setgid(gid)
1251
2500
os.setuid(uid)
1252
except OSError, error:
1253
if error[0] != errno.EPERM:
1254
raise error
2501
except OSError as error:
2502
if error.errno != errno.EPERM:
2503
raise
1255
2504
1256
# Enable all possible GnuTLS debugging
1257
2505
if debug:
2506
# Enable all possible GnuTLS debugging
2507
1258
2508
# "Use a log level over 10 to enable all debugging options."
1259
2509
# - GnuTLS manual
1260
2510
gnutls.library.functions.gnutls_global_set_log_level(11)
1265
2515
1266
2516
(gnutls.library.functions
1267
2517
.gnutls_global_set_log_function(debug_gnutls))
1268
1269
global service
1270
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1271
service = AvahiService(name = server_settings["servicename"],
1272
servicetype = "_mandos._tcp",
1273
protocol = protocol)
1274
if server_settings["interface"]:
1275
service.interface = (if_nametoindex
1276
(server_settings["interface"]))
2518
2519
# Redirect stdin so all checkers get /dev/null
2520
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2521
os.dup2(null, sys.stdin.fileno())
2522
if null > 2:
2523
os.close(null)
2524
2525
# Need to fork before connecting to D-Bus
2526
if not foreground:
2527
# Close all input and output, do double fork, etc.
2528
daemon()
2529
2530
# multiprocessing will use threads, so before we use gobject we
2531
# need to inform gobject that threads will be used.
2532
gobject.threads_init()
1277
2533
1278
2534
global main_loop
1279
global bus
1280
global server
1281
2535
# From the Avahi example code
1282
DBusGMainLoop(set_as_default=True )
2536
DBusGMainLoop(set_as_default=True)
1283
2537
main_loop = gobject.MainLoop()
1284
2538
bus = dbus.SystemBus()
1285
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1286
avahi.DBUS_PATH_SERVER),
1287
avahi.DBUS_INTERFACE_SERVER)
1288
2539
# End of Avahi example code
1289
2540
if use_dbus:
1290
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
2541
try:
2542
bus_name = dbus.service.BusName("se.recompile.Mandos",
2543
bus, do_not_queue=True)
2544
old_bus_name = (dbus.service.BusName
2545
("se.bsnet.fukt.Mandos", bus,
2546
do_not_queue=True))
2547
except dbus.exceptions.NameExistsException as e:
2548
logger.error("Disabling D-Bus:", exc_info=e)
2549
use_dbus = False
2550
server_settings["use_dbus"] = False
2551
tcp_server.use_dbus = False
2552
if zeroconf:
2553
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2554
service = AvahiServiceToSyslog(name =
2555
server_settings["servicename"],
2556
servicetype = "_mandos._tcp",
2557
protocol = protocol, bus = bus)
2558
if server_settings["interface"]:
2559
service.interface = (if_nametoindex
2560
(server_settings["interface"]
2561
.encode("utf-8")))
2562
2563
global multiprocessing_manager
2564
multiprocessing_manager = multiprocessing.Manager()
1291
2565
1292
2566
client_class = Client
1293
2567
if use_dbus:
1294
client_class = ClientDBus
1295
clients.update(Set(
1296
client_class(name = section,
1297
config= dict(client_config.items(section)))
1298
for section in client_config.sections()))
1299
if not clients:
1300
logger.warning(u"No clients defined")
1301
1302
if debug:
1303
# Redirect stdin so all checkers get /dev/null
1304
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1305
os.dup2(null, sys.stdin.fileno())
1306
if null > 2:
1307
os.close(null)
1308
else:
1309
# No console logging
1310
logger.removeHandler(console)
1311
# Close all input and output, do double fork, etc.
1312
daemon()
1313
1314
try:
1315
with closing(pidfile):
1316
pid = os.getpid()
1317
pidfile.write(str(pid) + "\n")
2568
client_class = functools.partial(ClientDBus, bus = bus)
2569
2570
client_settings = Client.config_parser(client_config)
2571
old_client_settings = {}
2572
clients_data = {}
2573
2574
# This is used to redirect stdout and stderr for checker processes
2575
global wnull
2576
wnull = open(os.devnull, "w") # A writable /dev/null
2577
# Only used if server is running in foreground but not in debug
2578
# mode
2579
if debug or not foreground:
2580
wnull.close()
2581
2582
# Get client data and settings from last running state.
2583
if server_settings["restore"]:
2584
try:
2585
with open(stored_state_path, "rb") as stored_state:
2586
clients_data, old_client_settings = (pickle.load
2587
(stored_state))
2588
os.remove(stored_state_path)
2589
except IOError as e:
2590
if e.errno == errno.ENOENT:
2591
logger.warning("Could not load persistent state: {}"
2592
.format(os.strerror(e.errno)))
2593
else:
2594
logger.critical("Could not load persistent state:",
2595
exc_info=e)
2596
raise
2597
except EOFError as e:
2598
logger.warning("Could not load persistent state: "
2599
"EOFError:", exc_info=e)
2600
2601
with PGPEngine() as pgp:
2602
for client_name, client in clients_data.items():
2603
# Skip removed clients
2604
if client_name not in client_settings:
2605
continue
2606
2607
# Decide which value to use after restoring saved state.
2608
# We have three different values: Old config file,
2609
# new config file, and saved state.
2610
# New config value takes precedence if it differs from old
2611
# config value, otherwise use saved state.
2612
for name, value in client_settings[client_name].items():
2613
try:
2614
# For each value in new config, check if it
2615
# differs from the old config value (Except for
2616
# the "secret" attribute)
2617
if (name != "secret" and
2618
value != old_client_settings[client_name]
2619
[name]):
2620
client[name] = value
2621
except KeyError:
2622
pass
2623
2624
# Clients who has passed its expire date can still be
2625
# enabled if its last checker was successful. Clients
2626
# whose checker succeeded before we stored its state is
2627
# assumed to have successfully run all checkers during
2628
# downtime.
2629
if client["enabled"]:
2630
if datetime.datetime.utcnow() >= client["expires"]:
2631
if not client["last_checked_ok"]:
2632
logger.warning(
2633
"disabling client {} - Client never "
2634
"performed a successful checker"
2635
.format(client_name))
2636
client["enabled"] = False
2637
elif client["last_checker_status"] != 0:
2638
logger.warning(
2639
"disabling client {} - Client last"
2640
" checker failed with error code {}"
2641
.format(client_name,
2642
client["last_checker_status"]))
2643
client["enabled"] = False
2644
else:
2645
client["expires"] = (datetime.datetime
2646
.utcnow()
2647
+ client["timeout"])
2648
logger.debug("Last checker succeeded,"
2649
" keeping {} enabled"
2650
.format(client_name))
2651
try:
2652
client["secret"] = (
2653
pgp.decrypt(client["encrypted_secret"],
2654
client_settings[client_name]
2655
["secret"]))
2656
except PGPError:
2657
# If decryption fails, we use secret from new settings
2658
logger.debug("Failed to decrypt {} old secret"
2659
.format(client_name))
2660
client["secret"] = (
2661
client_settings[client_name]["secret"])
2662
2663
# Add/remove clients based on new changes made to config
2664
for client_name in (set(old_client_settings)
2665
- set(client_settings)):
2666
del clients_data[client_name]
2667
for client_name in (set(client_settings)
2668
- set(old_client_settings)):
2669
clients_data[client_name] = client_settings[client_name]
2670
2671
# Create all client objects
2672
for client_name, client in clients_data.items():
2673
tcp_server.clients[client_name] = client_class(
2674
name = client_name, settings = client,
2675
server_settings = server_settings)
2676
2677
if not tcp_server.clients:
2678
logger.warning("No clients defined")
2679
2680
if not foreground:
2681
if pidfile is not None:
2682
try:
2683
with pidfile:
2684
pid = os.getpid()
2685
pidfile.write("{}\n".format(pid).encode("utf-8"))
2686
except IOError:
2687
logger.error("Could not write to file %r with PID %d",
2688
pidfilename, pid)
1318
2689
del pidfile
1319
except IOError:
1320
logger.error(u"Could not write to file %r with PID %d",
1321
pidfilename, pid)
1322
except NameError:
1323
# "pidfile" was never created
1324
pass
1325
del pidfilename
1326
1327
def cleanup():
1328
"Cleanup function; run on exit"
1329
global group
1330
# From the Avahi example code
1331
if not group is None:
1332
group.Free()
1333
group = None
1334
# End of Avahi example code
1335
1336
while clients:
1337
client = clients.pop()
1338
client.disable_hook = None
1339
client.disable()
1340
1341
atexit.register(cleanup)
1342
1343
if not debug:
1344
signal.signal(signal.SIGINT, signal.SIG_IGN)
2690
del pidfilename
2691
1345
2692
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1346
2693
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1347
2694
1348
2695
if use_dbus:
1349
class MandosDBusService(dbus.service.Object):
2696
@alternate_dbus_interfaces({"se.recompile.Mandos":
2697
"se.bsnet.fukt.Mandos"})
2698
class MandosDBusService(DBusObjectWithProperties):
1350
2699
"""A D-Bus proxy object"""
1351
2700
def __init__(self):
1352
2701
dbus.service.Object.__init__(self, bus, "/")
1353
_interface = u"se.bsnet.fukt.Mandos"
1354
1355
@dbus.service.signal(_interface, signature="oa{sv}")
1356
def ClientAdded(self, objpath, properties):
2702
_interface = "se.recompile.Mandos"
2703
2704
@dbus_interface_annotations(_interface)
2705
def _foo(self):
2706
return { "org.freedesktop.DBus.Property"
2707
".EmitsChangedSignal":
2708
"false"}
2709
2710
@dbus.service.signal(_interface, signature="o")
2711
def ClientAdded(self, objpath):
1357
2712
"D-Bus signal"
1358
2713
pass
1359
2714
1360
@dbus.service.signal(_interface, signature="s")
1361
def ClientNotFound(self, fingerprint):
2715
@dbus.service.signal(_interface, signature="ss")
2716
def ClientNotFound(self, fingerprint, address):
1362
2717
"D-Bus signal"
1363
2718
pass
1364
2719
1370
2725
@dbus.service.method(_interface, out_signature="ao")
1371
2726
def GetAllClients(self):
1372
2727
"D-Bus method"
1373
return dbus.Array(c.dbus_object_path for c in clients)
2728
return dbus.Array(c.dbus_object_path
2729
for c in
2730
tcp_server.clients.itervalues())
1374
2731
1375
@dbus.service.method(_interface, out_signature="a{oa{sv}}")
2732
@dbus.service.method(_interface,
2733
out_signature="a{oa{sv}}")
1376
2734
def GetAllClientsWithProperties(self):
1377
2735
"D-Bus method"
1378
2736
return dbus.Dictionary(
1379
((c.dbus_object_path, c.GetAllProperties())
1380
for c in clients),
2737
{ c.dbus_object_path: c.GetAll("")
2738
for c in tcp_server.clients.itervalues() },
1381
2739
signature="oa{sv}")
1382
2740
1383
2741
@dbus.service.method(_interface, in_signature="o")
1384
2742
def RemoveClient(self, object_path):
1385
2743
"D-Bus method"
1386
for c in clients:
2744
for c in tcp_server.clients.itervalues():
1387
2745
if c.dbus_object_path == object_path:
1388
clients.remove(c)
2746
del tcp_server.clients[c.name]
1389
2747
c.remove_from_connection()
1390
2748
# Don't signal anything except ClientRemoved
1391
c.disable(signal=False)
2749
c.disable(quiet=True)
1392
2750
# Emit D-Bus signal
1393
2751
self.ClientRemoved(object_path, c.name)
1394
2752
return
1395
raise KeyError
2753
raise KeyError(object_path)
1396
2754
1397
2755
del _interface
1398
2756
1399
2757
mandos_dbus_service = MandosDBusService()
1400
2758
1401
for client in clients:
2759
def cleanup():
2760
"Cleanup function; run on exit"
2761
if zeroconf:
2762
service.cleanup()
2763
2764
multiprocessing.active_children()
2765
wnull.close()
2766
if not (tcp_server.clients or client_settings):
2767
return
2768
2769
# Store client before exiting. Secrets are encrypted with key
2770
# based on what config file has. If config file is
2771
# removed/edited, old secret will thus be unrecovable.
2772
clients = {}
2773
with PGPEngine() as pgp:
2774
for client in tcp_server.clients.itervalues():
2775
key = client_settings[client.name]["secret"]
2776
client.encrypted_secret = pgp.encrypt(client.secret,
2777
key)
2778
client_dict = {}
2779
2780
# A list of attributes that can not be pickled
2781
# + secret.
2782
exclude = { "bus", "changedstate", "secret",
2783
"checker", "server_settings" }
2784
for name, typ in (inspect.getmembers
2785
(dbus.service.Object)):
2786
exclude.add(name)
2787
2788
client_dict["encrypted_secret"] = (client
2789
.encrypted_secret)
2790
for attr in client.client_structure:
2791
if attr not in exclude:
2792
client_dict[attr] = getattr(client, attr)
2793
2794
clients[client.name] = client_dict
2795
del client_settings[client.name]["secret"]
2796
2797
try:
2798
with (tempfile.NamedTemporaryFile
2799
(mode='wb', suffix=".pickle", prefix='clients-',
2800
dir=os.path.dirname(stored_state_path),
2801
delete=False)) as stored_state:
2802
pickle.dump((clients, client_settings), stored_state)
2803
tempname=stored_state.name
2804
os.rename(tempname, stored_state_path)
2805
except (IOError, OSError) as e:
2806
if not debug:
2807
try:
2808
os.remove(tempname)
2809
except NameError:
2810
pass
2811
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2812
logger.warning("Could not save persistent state: {}"
2813
.format(os.strerror(e.errno)))
2814
else:
2815
logger.warning("Could not save persistent state:",
2816
exc_info=e)
2817
raise
2818
2819
# Delete all clients, and settings from config
2820
while tcp_server.clients:
2821
name, client = tcp_server.clients.popitem()
2822
if use_dbus:
2823
client.remove_from_connection()
2824
# Don't signal anything except ClientRemoved
2825
client.disable(quiet=True)
2826
if use_dbus:
2827
# Emit D-Bus signal
2828
mandos_dbus_service.ClientRemoved(client
2829
.dbus_object_path,
2830
client.name)
2831
client_settings.clear()
2832
2833
atexit.register(cleanup)
2834
2835
for client in tcp_server.clients.itervalues():
1402
2836
if use_dbus:
1403
2837
# Emit D-Bus signal
1404
mandos_dbus_service.ClientAdded(client.dbus_object_path,
1405
client.GetAllProperties())
1406
client.enable()
2838
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2839
# Need to initiate checking of clients
2840
if client.enabled:
2841
client.init_checker()
1407
2842
1408
2843
tcp_server.enable()
1409
2844
tcp_server.server_activate()
1410
2845
1411
2846
# Find out what port we got
1412
service.port = tcp_server.socket.getsockname()[1]
2847
if zeroconf:
2848
service.port = tcp_server.socket.getsockname()[1]
1413
2849
if use_ipv6:
1414
logger.info(u"Now listening on address %r, port %d,"
1415
" flowinfo %d, scope_id %d"
1416
% tcp_server.socket.getsockname())
2850
logger.info("Now listening on address %r, port %d,"
2851
" flowinfo %d, scope_id %d",
2852
*tcp_server.socket.getsockname())
1417
2853
else: # IPv4
1418
logger.info(u"Now listening on address %r, port %d"
1419
% tcp_server.socket.getsockname())
2854
logger.info("Now listening on address %r, port %d",
2855
*tcp_server.socket.getsockname())
1420
2856
1421
2857
#service.interface = tcp_server.socket.getsockname()[3]
1422
2858
1423
2859
try:
1424
# From the Avahi example code
1425
server.connect_to_signal("StateChanged", server_state_changed)
1426
try:
1427
server_state_changed(server.GetState())
1428
except dbus.exceptions.DBusException, error:
1429
logger.critical(u"DBusException: %s", error)
1430
sys.exit(1)
1431
# End of Avahi example code
2860
if zeroconf:
2861
# From the Avahi example code
2862
try:
2863
service.activate()
2864
except dbus.exceptions.DBusException as error:
2865
logger.critical("D-Bus Exception", exc_info=error)
2866
cleanup()
2867
sys.exit(1)
2868
# End of Avahi example code
1432
2869
1433
2870
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1434
2871
lambda *args, **kwargs:
1435
2872
(tcp_server.handle_request
1436
2873
(*args[2:], **kwargs) or True))
1437
2874
1438
logger.debug(u"Starting main loop")
2875
logger.debug("Starting main loop")
1439
2876
main_loop.run()
1440
except AvahiError, error:
1441
logger.critical(u"AvahiError: %s", error)
2877
except AvahiError as error:
2878
logger.critical("Avahi Error", exc_info=error)
2879
cleanup()
1442
2880
sys.exit(1)
1443
2881
except KeyboardInterrupt:
1444
2882
if debug:
1445
print >> sys.stderr
2883
print("", file=sys.stderr)
1446
2884
logger.debug("Server received KeyboardInterrupt")
1447
2885
logger.debug("Server exiting")
2886
# Must run before the D-Bus bus name gets deregistered
2887
cleanup()
1448
2888
1449
2889
if __name__ == '__main__':
1450
2890
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0