To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 237.7.292
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.292
- Committer: Teddy Hogeborn
- Date: 2015-04-02 18:59:29 UTC
- mto: (237.7.304 trunk)
- mto: This revision was merged to the branch mainline in revision 325.
- Revision ID: teddy@recompile.se-20150402185929-1q1rf1zelbpzzn74
Add "!RSA" also to examples/documentation.
* mandos.conf (priority): Add "!RSA" to default commented-out value.
* mandos.conf.xml (EXAMPLE): Add "!RSA" to example priority setting.
* mandos.conf (priority): Add "!RSA" to default commented-out value.
* mandos.conf.xml (EXAMPLE): Add "!RSA" to example priority setting.
- files added:
- DBUS-API
- debian/source
- debian/upstream
- network-hooks.d
- files removed:
- plugins.d/plymouth
- 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.
11
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
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
36
37
from future_builtins import *
35
38
36
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
61
64
import functools
62
65
import cPickle as pickle
63
66
import multiprocessing
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
import collections
64
72
65
73
import dbus
66
74
import dbus.service
80
88
except ImportError:
81
89
SO_BINDTODEVICE = None
82
90
83
84
version = "1.0.14"
85
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
88
syslogger = (logging.handlers.SysLogHandler
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
93
u' %(message)s'))
94
logger.addHandler(syslogger)
95
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
u' %(levelname)s:'
99
u' %(message)s'))
100
logger.addHandler(console)
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
101
224
102
225
class AvahiError(Exception):
103
226
def __init__(self, value, *args, **kwargs):
104
227
self.value = value
105
super(AvahiError, self).__init__(value, *args, **kwargs)
106
def __unicode__(self):
107
return unicode(repr(self.value))
228
return super(AvahiError, self).__init__(value, *args,
229
**kwargs)
108
230
109
231
class AvahiServiceError(AvahiError):
110
232
pass
119
241
Attributes:
120
242
interface: integer; avahi.IF_UNSPEC or an interface index.
121
243
Used to optionally bind to the specified interface.
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
244
name: string; Example: 'Mandos'
245
type: string; Example: '_mandos._tcp'.
246
See <https://www.iana.org/assignments/service-names-port-numbers>
125
247
port: integer; what port to announce
126
248
TXT: list of strings; TXT record for the service
127
249
domain: string; Domain to publish on, default to .local if empty.
133
255
server: D-Bus Server
134
256
bus: dbus.SystemBus()
135
257
"""
258
136
259
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
137
260
servicetype = None, port = None, TXT = None,
138
domain = u"", host = u"", max_renames = 32768,
261
domain = "", host = "", max_renames = 32768,
139
262
protocol = avahi.PROTO_UNSPEC, bus = None):
140
263
self.interface = interface
141
264
self.name = name
150
273
self.group = None # our entry group
151
274
self.server = None
152
275
self.bus = bus
153
def rename(self):
276
self.entry_group_state_changed_match = None
277
278
def rename(self, remove=True):
154
279
"""Derived from the Avahi example code"""
155
280
if self.rename_count >= self.max_renames:
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
281
logger.critical("No suitable Zeroconf service name found"
282
" after %i retries, exiting.",
158
283
self.rename_count)
159
raise AvahiServiceError(u"Too many renames")
160
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
161
logger.info(u"Changing Zeroconf service name to %r ...",
284
raise AvahiServiceError("Too many renames")
285
self.name = str(self.server
286
.GetAlternativeServiceName(self.name))
287
self.rename_count += 1
288
logger.info("Changing Zeroconf service name to %r ...",
162
289
self.name)
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
166
% self.name))
167
self.remove()
168
self.add()
169
self.rename_count += 1
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
170
304
def remove(self):
171
305
"""Derived from the Avahi example code"""
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
172
309
if self.group is not None:
173
310
self.group.Reset()
311
174
312
def add(self):
175
313
"""Derived from the Avahi example code"""
314
self.remove()
176
315
if self.group is None:
177
316
self.group = dbus.Interface(
178
317
self.bus.get_object(avahi.DBUS_NAME,
179
318
self.server.EntryGroupNew()),
180
319
avahi.DBUS_INTERFACE_ENTRY_GROUP)
181
self.group.connect_to_signal('StateChanged',
182
self
183
.entry_group_state_changed)
184
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
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' ...",
185
324
self.name, self.type)
186
325
self.group.AddService(
187
326
self.interface,
192
331
dbus.UInt16(self.port),
193
332
avahi.string_array_to_txt_array(self.TXT))
194
333
self.group.Commit()
334
195
335
def entry_group_state_changed(self, state, error):
196
336
"""Derived from the Avahi example code"""
197
logger.debug(u"Avahi entry group state change: %i", state)
337
logger.debug("Avahi entry group state change: %i", state)
198
338
199
339
if state == avahi.ENTRY_GROUP_ESTABLISHED:
200
logger.debug(u"Zeroconf service established.")
340
logger.debug("Zeroconf service established.")
201
341
elif state == avahi.ENTRY_GROUP_COLLISION:
202
logger.warning(u"Zeroconf service name collision.")
342
logger.info("Zeroconf service name collision.")
203
343
self.rename()
204
344
elif state == avahi.ENTRY_GROUP_FAILURE:
205
logger.critical(u"Avahi: Error in group state changed %s",
206
unicode(error))
207
raise AvahiGroupError(u"State changed: %s"
208
% unicode(error))
345
logger.critical("Avahi: Error in group state changed %s",
346
str(error))
347
raise AvahiGroupError("State changed: {!s}"
348
.format(error))
349
209
350
def cleanup(self):
210
351
"""Derived from the Avahi example code"""
211
352
if self.group is not None:
212
self.group.Free()
353
try:
354
self.group.Free()
355
except (dbus.exceptions.UnknownMethodException,
356
dbus.exceptions.DBusException):
357
pass
213
358
self.group = None
214
def server_state_changed(self, state):
359
self.remove()
360
361
def server_state_changed(self, state, error=None):
215
362
"""Derived from the Avahi example code"""
216
logger.debug(u"Avahi server state change: %i", state)
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
219
self.remove()
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()
220
378
elif state == avahi.SERVER_RUNNING:
221
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
222
386
def activate(self):
223
387
"""Derived from the Avahi example code"""
224
388
if self.server is None:
225
389
self.server = dbus.Interface(
226
390
self.bus.get_object(avahi.DBUS_NAME,
227
avahi.DBUS_PATH_SERVER),
391
avahi.DBUS_PATH_SERVER,
392
follow_name_owner_changes=True),
228
393
avahi.DBUS_INTERFACE_SERVER)
229
self.server.connect_to_signal(u"StateChanged",
394
self.server.connect_to_signal("StateChanged",
230
395
self.server_state_changed)
231
396
self.server_state_changed(self.server.GetState())
232
397
233
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
408
409
234
410
class Client(object):
235
411
"""A representation of a client host served by this server.
236
412
237
413
Attributes:
238
name: string; from the config file, used in log messages and
239
D-Bus identifiers
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
417
checker: subprocess.Popen(); a running checker process used
418
to see if the client lives.
419
'None' if no process is running.
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
423
runtime with vars(self) as dict, so that for
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
429
current_checker_command: string; current running checker_command
430
disable_initiator_tag: a gobject event source tag, or None
431
enabled: bool()
240
432
fingerprint: string (40 or 32 hexadecimal digits); used to
241
433
uniquely identify the client
242
secret: bytestring; sent verbatim (over TLS) to client
243
434
host: string; available for use by the checker command
244
created: datetime.datetime(); (UTC) object creation
245
last_enabled: datetime.datetime(); (UTC)
246
enabled: bool()
435
interval: datetime.timedelta(); How often to start a new checker
436
last_approval_request: datetime.datetime(); (UTC) or None
247
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
248
445
timeout: datetime.timedelta(); How long from last_checked_ok
249
446
until this client is disabled
250
interval: datetime.timedelta(); How often to start a new checker
251
disable_hook: If set, called by disable() as disable_hook(self)
252
checker: subprocess.Popen(); a running checker process used
253
to see if the client lives.
254
'None' if no process is running.
255
checker_initiator_tag: a gobject event source tag, or None
256
disable_initiator_tag: - '' -
257
checker_callback_tag: - '' -
258
checker_command: string; External command which is run to check if
259
client lives. %() expansions are done at
260
runtime with vars(self) as dict, so that for
261
instance %(name)s can be used in the command.
262
current_checker_command: string; current running checker_command
263
approved_delay: datetime.timedelta(); Time to wait for approval
264
_approved: bool(); 'None' if not yet approved/disapproved
265
approved_duration: datetime.timedelta(); Duration of one approval
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()
266
452
"""
267
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
268
470
@staticmethod
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
274
275
def timeout_milliseconds(self):
276
"Return the 'timeout' attribute in milliseconds"
277
return self._timedelta_to_milliseconds(self.timeout)
278
279
def interval_milliseconds(self):
280
"Return the 'interval' attribute in milliseconds"
281
return self._timedelta_to_milliseconds(self.interval)
282
283
def approved_delay_milliseconds(self):
284
return self._timedelta_to_milliseconds(self.approved_delay)
285
286
def __init__(self, name = None, disable_hook=None, config=None):
287
"""Note: the 'checker' key in 'config' sets the
288
'checker_command' attribute and *not* the 'checker'
289
attribute."""
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):
290
521
self.name = name
291
if config is None:
292
config = {}
293
logger.debug(u"Creating client %r", self.name)
294
# Uppercase and remove spaces from fingerprint for later
295
# comparison purposes with return value from the fingerprint()
296
# function
297
self.fingerprint = (config[u"fingerprint"].upper()
298
.replace(u" ", u""))
299
logger.debug(u" Fingerprint: %s", self.fingerprint)
300
if u"secret" in config:
301
self.secret = config[u"secret"].decode(u"base64")
302
elif u"secfile" in config:
303
with open(os.path.expanduser(os.path.expandvars
304
(config[u"secfile"])),
305
"rb") as secfile:
306
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)
307
535
else:
308
raise TypeError(u"No secret or secfile for client %s"
309
% self.name)
310
self.host = config.get(u"host", u"")
311
self.created = datetime.datetime.utcnow()
312
self.enabled = False
313
self.last_enabled = None
314
self.last_checked_ok = None
315
self.timeout = string_to_delta(config[u"timeout"])
316
self.interval = string_to_delta(config[u"interval"])
317
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
318
545
self.checker = None
319
546
self.checker_initiator_tag = None
320
547
self.disable_initiator_tag = None
321
548
self.checker_callback_tag = None
322
self.checker_command = config[u"checker"]
323
549
self.current_checker_command = None
324
self.last_connect = None
325
self._approved = None
326
self.approved_by_default = config.get(u"approved_by_default",
327
True)
550
self.approved = None
328
551
self.approvals_pending = 0
329
self.approved_delay = string_to_delta(
330
config[u"approved_delay"])
331
self.approved_duration = string_to_delta(
332
config[u"approved_duration"])
333
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
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)
334
566
567
# Send notice to process children that client state has changed
335
568
def send_changedstate(self):
336
self.changedstate.acquire()
337
self.changedstate.notify_all()
338
self.changedstate.release()
339
569
with self.changedstate:
570
self.changedstate.notify_all()
571
340
572
def enable(self):
341
573
"""Start this client's checker and timeout hooks"""
342
if getattr(self, u"enabled", False):
574
if getattr(self, "enabled", False):
343
575
# Already enabled
344
576
return
345
self.send_changedstate()
577
self.expires = datetime.datetime.utcnow() + self.timeout
578
self.enabled = True
346
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):
347
607
# Schedule a new checker to be started an 'interval' from now,
348
608
# and every interval from then on.
609
if self.checker_initiator_tag is not None:
610
gobject.source_remove(self.checker_initiator_tag)
349
611
self.checker_initiator_tag = (gobject.timeout_add
350
(self.interval_milliseconds(),
612
(int(self.interval
613
.total_seconds() * 1000),
351
614
self.start_checker))
352
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)
353
618
self.disable_initiator_tag = (gobject.timeout_add
354
(self.timeout_milliseconds(),
355
self.disable))
356
self.enabled = True
619
(int(self.timeout
620
.total_seconds() * 1000),
621
self.disable))
357
622
# Also start a new checker *right now*.
358
623
self.start_checker()
359
624
360
def disable(self, quiet=True):
361
"""Disable this client."""
362
if not getattr(self, "enabled", False):
363
return False
364
if not quiet:
365
self.send_changedstate()
366
if not quiet:
367
logger.info(u"Disabling client %s", self.name)
368
if getattr(self, u"disable_initiator_tag", False):
369
gobject.source_remove(self.disable_initiator_tag)
370
self.disable_initiator_tag = None
371
if getattr(self, u"checker_initiator_tag", False):
372
gobject.source_remove(self.checker_initiator_tag)
373
self.checker_initiator_tag = None
374
self.stop_checker()
375
if self.disable_hook:
376
self.disable_hook(self)
377
self.enabled = False
378
# Do not run this again if called by a gobject.timeout_add
379
return False
380
381
def __del__(self):
382
self.disable_hook = None
383
self.disable()
384
385
625
def checker_callback(self, pid, condition, command):
386
626
"""The checker has completed, so take appropriate actions."""
387
627
self.checker_callback_tag = None
388
628
self.checker = None
389
629
if os.WIFEXITED(condition):
390
exitstatus = os.WEXITSTATUS(condition)
391
if exitstatus == 0:
392
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",
393
633
vars(self))
394
634
self.checked_ok()
395
635
else:
396
logger.info(u"Checker for %(name)s failed",
636
logger.info("Checker for %(name)s failed",
397
637
vars(self))
398
638
else:
399
logger.warning(u"Checker for %(name)s crashed?",
639
self.last_checker_status = -1
640
logger.warning("Checker for %(name)s crashed?",
400
641
vars(self))
401
642
402
643
def checked_ok(self):
403
"""Bump up the timeout for this client.
404
405
This should only be called when the client has been seen,
406
alive and well.
407
"""
644
"""Assert that the client has been seen, alive and well."""
408
645
self.last_checked_ok = datetime.datetime.utcnow()
409
gobject.source_remove(self.disable_initiator_tag)
410
self.disable_initiator_tag = (gobject.timeout_add
411
(self.timeout_milliseconds(),
412
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()
413
664
414
665
def start_checker(self):
415
666
"""Start a new checker subprocess if one is not running.
417
668
If a checker already exists, leave it running and do
418
669
nothing."""
419
670
# The reason for not killing a running checker is that if we
420
# did that, then if a checker (for some reason) started
421
# running slowly and taking more than 'interval' time, the
422
# client would inevitably timeout, since no checker would get
423
# 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
424
675
# checkers alone, the checker would have to take more time
425
676
# than 'timeout' for the client to be disabled, which is as it
426
677
# should be.
428
679
# If a checker exists, make sure it is not a zombie
429
680
try:
430
681
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
431
except (AttributeError, OSError), error:
432
if (isinstance(error, OSError)
433
and error.errno != errno.ECHILD):
434
raise error
682
except AttributeError:
683
pass
684
except OSError as error:
685
if error.errno != errno.ECHILD:
686
raise
435
687
else:
436
688
if pid:
437
logger.warning(u"Checker was a zombie")
689
logger.warning("Checker was a zombie")
438
690
gobject.source_remove(self.checker_callback_tag)
439
691
self.checker_callback(pid, status,
440
692
self.current_checker_command)
441
693
# Start a new checker if needed
442
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 }
443
699
try:
444
# In case checker_command has exactly one % operator
445
command = self.checker_command % self.host
446
except TypeError:
447
# Escape attributes for the shell
448
escaped_attrs = dict((key,
449
re.escape(unicode(str(val),
450
errors=
451
u'replace')))
452
for key, val in
453
vars(self).iteritems())
454
try:
455
command = self.checker_command % escaped_attrs
456
except TypeError, error:
457
logger.error(u'Could not format string "%s":'
458
u' %s', self.checker_command, error)
459
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
460
705
self.current_checker_command = command
461
706
try:
462
logger.info(u"Starting checker %r for %s",
707
logger.info("Starting checker %r for %s",
463
708
command, self.name)
464
709
# We don't need to redirect stdout and stderr, since
465
710
# in normal mode, that is already done by daemon(),
466
711
# and in debug mode we don't want to. (Stdin is
467
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 })
468
721
self.checker = subprocess.Popen(command,
469
722
close_fds=True,
470
shell=True, cwd=u"/")
471
self.checker_callback_tag = (gobject.child_watch_add
472
(self.checker.pid,
473
self.checker_callback,
474
data=command))
475
# The checker may have completed before the gobject
476
# 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:
477
736
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
478
if pid:
479
gobject.source_remove(self.checker_callback_tag)
480
self.checker_callback(pid, status, command)
481
except OSError, error:
482
logger.error(u"Failed to start subprocess: %s",
483
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)
484
747
# Re-run this periodically if run by gobject.timeout_add
485
748
return True
486
749
489
752
if self.checker_callback_tag:
490
753
gobject.source_remove(self.checker_callback_tag)
491
754
self.checker_callback_tag = None
492
if getattr(self, u"checker", None) is None:
755
if getattr(self, "checker", None) is None:
493
756
return
494
logger.debug(u"Stopping checker for %(name)s", vars(self))
757
logger.debug("Stopping checker for %(name)s", vars(self))
495
758
try:
496
os.kill(self.checker.pid, signal.SIGTERM)
759
self.checker.terminate()
497
760
#time.sleep(0.5)
498
761
#if self.checker.poll() is None:
499
# os.kill(self.checker.pid, signal.SIGKILL)
500
except OSError, error:
762
# self.checker.kill()
763
except OSError as error:
501
764
if error.errno != errno.ESRCH: # No such process
502
765
raise
503
766
self.checker = None
504
767
505
def dbus_service_property(dbus_interface, signature=u"v",
506
access=u"readwrite", byte_arrays=False):
768
769
def dbus_service_property(dbus_interface, signature="v",
770
access="readwrite", byte_arrays=False):
507
771
"""Decorators for marking methods of a DBusObjectWithProperties to
508
772
become properties on the D-Bus.
509
773
516
780
"""
517
781
# Encoding deeply encoded byte arrays is not supported yet by the
518
782
# "Set" method, so we fail early here:
519
if byte_arrays and signature != u"ay":
520
raise ValueError(u"Byte arrays not supported for non-'ay'"
521
u" signature %r" % signature)
783
if byte_arrays and signature != "ay":
784
raise ValueError("Byte arrays not supported for non-'ay'"
785
" signature {!r}".format(signature))
522
786
def decorator(func):
523
787
func._dbus_is_property = True
524
788
func._dbus_interface = dbus_interface
525
789
func._dbus_signature = signature
526
790
func._dbus_access = access
527
791
func._dbus_name = func.__name__
528
if func._dbus_name.endswith(u"_dbus_property"):
792
if func._dbus_name.endswith("_dbus_property"):
529
793
func._dbus_name = func._dbus_name[:-14]
530
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
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
531
832
return func
532
833
return decorator
533
834
535
836
class DBusPropertyException(dbus.exceptions.DBusException):
536
837
"""A base class for D-Bus property-related exceptions
537
838
"""
538
def __unicode__(self):
539
return unicode(str(self))
540
839
pass
541
840
542
841
class DBusPropertyAccessException(DBusPropertyException):
543
842
"""A property's access permissions disallows an operation.
553
852
554
853
class DBusObjectWithProperties(dbus.service.Object):
555
854
"""A D-Bus object with properties.
556
855
557
856
Classes inheriting from this can use the dbus_service_property
558
857
decorator to expose methods as D-Bus properties. It exposes the
559
858
standard Get(), Set(), and GetAll() methods on the D-Bus.
560
859
"""
561
860
562
861
@staticmethod
563
def _is_dbus_property(obj):
564
return getattr(obj, u"_dbus_is_property", False)
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)
565
870
566
def _get_all_dbus_properties(self):
871
def _get_all_dbus_things(self, thing):
567
872
"""Returns a generator of (name, attribute) pairs
568
873
"""
569
return ((prop._dbus_name, prop)
570
for name, prop in
571
inspect.getmembers(self, self._is_dbus_property))
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)))
572
881
573
882
def _get_dbus_property(self, interface_name, property_name):
574
883
"""Returns a bound method if one exists which is a D-Bus
575
884
property with the specified name and interface.
576
885
"""
577
for name in (property_name,
578
property_name + u"_dbus_property"):
579
prop = getattr(self, name, None)
580
if (prop is None
581
or not self._is_dbus_property(prop)
582
or prop._dbus_name != property_name
583
or (interface_name and prop._dbus_interface
584
and interface_name != prop._dbus_interface)):
585
continue
586
return prop
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
587
894
# No such property
588
raise DBusPropertyNotFound(self.dbus_object_path + u":"
589
+ interface_name + u"."
895
raise DBusPropertyNotFound(self.dbus_object_path + ":"
896
+ interface_name + "."
590
897
+ property_name)
591
898
592
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
593
out_signature=u"v")
899
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
900
out_signature="v")
594
901
def Get(self, interface_name, property_name):
595
902
"""Standard D-Bus property Get() method, see D-Bus standard.
596
903
"""
597
904
prop = self._get_dbus_property(interface_name, property_name)
598
if prop._dbus_access == u"write":
905
if prop._dbus_access == "write":
599
906
raise DBusPropertyAccessException(property_name)
600
907
value = prop()
601
if not hasattr(value, u"variant_level"):
908
if not hasattr(value, "variant_level"):
602
909
return value
603
910
return type(value)(value, variant_level=value.variant_level+1)
604
911
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
606
913
def Set(self, interface_name, property_name, value):
607
914
"""Standard D-Bus property Set() method, see D-Bus standard.
608
915
"""
609
916
prop = self._get_dbus_property(interface_name, property_name)
610
if prop._dbus_access == u"read":
917
if prop._dbus_access == "read":
611
918
raise DBusPropertyAccessException(property_name)
612
if prop._dbus_get_args_options[u"byte_arrays"]:
919
if prop._dbus_get_args_options["byte_arrays"]:
613
920
# The byte_arrays option is not supported yet on
614
921
# signatures other than "ay".
615
if prop._dbus_signature != u"ay":
616
raise ValueError
617
value = dbus.ByteArray(''.join(unichr(byte)
618
for byte in value))
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))
619
928
prop(value)
620
929
621
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
622
out_signature=u"a{sv}")
930
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
931
out_signature="a{sv}")
623
932
def GetAll(self, interface_name):
624
933
"""Standard D-Bus property GetAll() method, see D-Bus
625
934
standard.
626
935
627
936
Note: Will not include properties with access="write".
628
937
"""
629
all = {}
630
for name, prop in self._get_all_dbus_properties():
938
properties = {}
939
for name, prop in self._get_all_dbus_things("property"):
631
940
if (interface_name
632
941
and interface_name != prop._dbus_interface):
633
942
# Interface non-empty but did not match
634
943
continue
635
944
# Ignore write-only properties
636
if prop._dbus_access == u"write":
945
if prop._dbus_access == "write":
637
946
continue
638
947
value = prop()
639
if not hasattr(value, u"variant_level"):
640
all[name] = value
948
if not hasattr(value, "variant_level"):
949
properties[name] = value
641
950
continue
642
all[name] = type(value)(value, variant_level=
643
value.variant_level+1)
644
return dbus.Dictionary(all, signature=u"sv")
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
645
962
646
963
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
647
out_signature=u"s",
964
out_signature="s",
648
965
path_keyword='object_path',
649
966
connection_keyword='connection')
650
967
def Introspect(self, object_path, connection):
651
"""Standard D-Bus method, overloaded to insert property tags.
968
"""Overloading of standard D-Bus method.
969
970
Inserts property tags and interface annotation tags.
652
971
"""
653
972
xmlstring = dbus.service.Object.Introspect(self, object_path,
654
973
connection)
655
974
try:
656
975
document = xml.dom.minidom.parseString(xmlstring)
657
976
def make_tag(document, name, prop):
658
e = document.createElement(u"property")
659
e.setAttribute(u"name", name)
660
e.setAttribute(u"type", prop._dbus_signature)
661
e.setAttribute(u"access", prop._dbus_access)
977
e = document.createElement("property")
978
e.setAttribute("name", name)
979
e.setAttribute("type", prop._dbus_signature)
980
e.setAttribute("access", prop._dbus_access)
662
981
return e
663
for if_tag in document.getElementsByTagName(u"interface"):
982
for if_tag in document.getElementsByTagName("interface"):
983
# Add property tags
664
984
for tag in (make_tag(document, name, prop)
665
985
for name, prop
666
in self._get_all_dbus_properties()
986
in self._get_all_dbus_things("property")
667
987
if prop._dbus_interface
668
== if_tag.getAttribute(u"name")):
988
== if_tag.getAttribute("name")):
669
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)
670
1021
# Add the names to the return values for the
671
1022
# "org.freedesktop.DBus.Properties" methods
672
if (if_tag.getAttribute(u"name")
673
== u"org.freedesktop.DBus.Properties"):
674
for cn in if_tag.getElementsByTagName(u"method"):
675
if cn.getAttribute(u"name") == u"Get":
676
for arg in cn.getElementsByTagName(u"arg"):
677
if (arg.getAttribute(u"direction")
678
== u"out"):
679
arg.setAttribute(u"name", u"value")
680
elif cn.getAttribute(u"name") == u"GetAll":
681
for arg in cn.getElementsByTagName(u"arg"):
682
if (arg.getAttribute(u"direction")
683
== u"out"):
684
arg.setAttribute(u"name", u"props")
685
xmlstring = document.toxml(u"utf-8")
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")
686
1037
document.unlink()
687
1038
except (AttributeError, xml.dom.DOMException,
688
xml.parsers.expat.ExpatError), error:
689
logger.error(u"Failed to override Introspection method",
690
error)
1039
xml.parsers.expat.ExpatError) as error:
1040
logger.error("Failed to override Introspection method",
1041
exc_info=error)
691
1042
return xmlstring
692
1043
693
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"})
694
1224
class ClientDBus(Client, DBusObjectWithProperties):
695
1225
"""A Client class using D-Bus
696
1226
698
1228
dbus_object_path: dbus.ObjectPath
699
1229
bus: dbus.SystemBus()
700
1230
"""
1231
1232
runtime_expansions = (Client.runtime_expansions
1233
+ ("dbus_object_path",))
1234
1235
_interface = "se.recompile.Mandos.Client"
1236
701
1237
# dbus.service.Object doesn't use super(), so we can't either.
702
1238
703
1239
def __init__(self, bus = None, *args, **kwargs):
704
self._approvals_pending = 0
705
1240
self.bus = bus
706
1241
Client.__init__(self, *args, **kwargs)
707
1242
# Only now, when this client is initialized, can it show up on
708
1243
# the D-Bus
1244
client_object_name = str(self.name).translate(
1245
{ord("."): ord("_"),
1246
ord("-"): ord("_")})
709
1247
self.dbus_object_path = (dbus.ObjectPath
710
(u"/clients/"
711
+ self.name.replace(u".", u"_")))
1248
("/clients/" + client_object_name))
712
1249
DBusObjectWithProperties.__init__(self, self.bus,
713
1250
self.dbus_object_path)
714
715
def _get_approvals_pending(self):
716
return self._approvals_pending
717
def _set_approvals_pending(self, value):
718
old_value = self._approvals_pending
719
self._approvals_pending = value
720
bval = bool(value)
721
if (hasattr(self, "dbus_object_path")
722
and bval is not bool(old_value)):
723
dbus_bool = dbus.Boolean(bval, variant_level=1)
724
self.PropertyChanged(dbus.String(u"approved_pending"),
725
dbus_bool)
726
727
approvals_pending = property(_get_approvals_pending,
728
_set_approvals_pending)
729
del _get_approvals_pending, _set_approvals_pending
730
731
@staticmethod
732
def _datetime_to_dbus(dt, variant_level=0):
733
"""Convert a UTC datetime.datetime() to a D-Bus type."""
734
return dbus.String(dt.isoformat(),
735
variant_level=variant_level)
736
737
def enable(self):
738
oldstate = getattr(self, u"enabled", False)
739
r = Client.enable(self)
740
if oldstate != self.enabled:
741
# Emit D-Bus signals
742
self.PropertyChanged(dbus.String(u"enabled"),
743
dbus.Boolean(True, variant_level=1))
744
self.PropertyChanged(
745
dbus.String(u"last_enabled"),
746
self._datetime_to_dbus(self.last_enabled,
747
variant_level=1))
748
return r
749
750
def disable(self, quiet = False):
751
oldstate = getattr(self, u"enabled", False)
752
r = Client.disable(self, quiet=quiet)
753
if not quiet and oldstate != self.enabled:
754
# Emit D-Bus signal
755
self.PropertyChanged(dbus.String(u"enabled"),
756
dbus.Boolean(False, variant_level=1))
757
return r
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
758
1334
759
1335
def __del__(self, *args, **kwargs):
760
1336
try:
761
1337
self.remove_from_connection()
762
1338
except LookupError:
763
1339
pass
764
if hasattr(DBusObjectWithProperties, u"__del__"):
1340
if hasattr(DBusObjectWithProperties, "__del__"):
765
1341
DBusObjectWithProperties.__del__(self, *args, **kwargs)
766
1342
Client.__del__(self, *args, **kwargs)
767
1343
769
1345
*args, **kwargs):
770
1346
self.checker_callback_tag = None
771
1347
self.checker = None
772
# Emit D-Bus signal
773
self.PropertyChanged(dbus.String(u"checker_running"),
774
dbus.Boolean(False, variant_level=1))
775
1348
if os.WIFEXITED(condition):
776
1349
exitstatus = os.WEXITSTATUS(condition)
777
1350
# Emit D-Bus signal
787
1360
return Client.checker_callback(self, pid, condition, command,
788
1361
*args, **kwargs)
789
1362
790
def checked_ok(self, *args, **kwargs):
791
r = Client.checked_ok(self, *args, **kwargs)
792
# Emit D-Bus signal
793
self.PropertyChanged(
794
dbus.String(u"last_checked_ok"),
795
(self._datetime_to_dbus(self.last_checked_ok,
796
variant_level=1)))
797
return r
798
799
1363
def start_checker(self, *args, **kwargs):
800
old_checker = self.checker
801
if self.checker is not None:
802
old_checker_pid = self.checker.pid
803
else:
804
old_checker_pid = None
1364
old_checker_pid = getattr(self.checker, "pid", None)
805
1365
r = Client.start_checker(self, *args, **kwargs)
806
1366
# Only if new checker process was started
807
1367
if (self.checker is not None
808
1368
and old_checker_pid != self.checker.pid):
809
1369
# Emit D-Bus signal
810
1370
self.CheckerStarted(self.current_checker_command)
811
self.PropertyChanged(
812
dbus.String(u"checker_running"),
813
dbus.Boolean(True, variant_level=1))
814
1371
return r
815
1372
816
def stop_checker(self, *args, **kwargs):
817
old_checker = getattr(self, u"checker", None)
818
r = Client.stop_checker(self, *args, **kwargs)
819
if (old_checker is not None
820
and getattr(self, u"checker", None) is None):
821
self.PropertyChanged(dbus.String(u"checker_running"),
822
dbus.Boolean(False, variant_level=1))
823
return r
824
825
1373
def _reset_approved(self):
826
self._approved = None
1374
self.approved = None
827
1375
return False
828
1376
829
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)
830
1381
self.send_changedstate()
831
self._approved = value
832
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration),
833
self._reset_approved)
834
835
1382
836
1383
## D-Bus methods, signals & properties
837
_interface = u"se.bsnet.fukt.Mandos.Client"
1384
1385
## Interfaces
838
1386
839
1387
## Signals
840
1388
841
1389
# CheckerCompleted - signal
842
@dbus.service.signal(_interface, signature=u"nxs")
1390
@dbus.service.signal(_interface, signature="nxs")
843
1391
def CheckerCompleted(self, exitcode, waitstatus, command):
844
1392
"D-Bus signal"
845
1393
pass
846
1394
847
1395
# CheckerStarted - signal
848
@dbus.service.signal(_interface, signature=u"s")
1396
@dbus.service.signal(_interface, signature="s")
849
1397
def CheckerStarted(self, command):
850
1398
"D-Bus signal"
851
1399
pass
852
1400
853
1401
# PropertyChanged - signal
854
@dbus.service.signal(_interface, signature=u"sv")
1402
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1403
@dbus.service.signal(_interface, signature="sv")
855
1404
def PropertyChanged(self, property, value):
856
1405
"D-Bus signal"
857
1406
pass
866
1415
pass
867
1416
868
1417
# Rejected - signal
869
@dbus.service.signal(_interface, signature=u"s")
1418
@dbus.service.signal(_interface, signature="s")
870
1419
def Rejected(self, reason):
871
1420
"D-Bus signal"
872
1421
pass
873
1422
874
1423
# NeedApproval - signal
875
@dbus.service.signal(_interface, signature=u"db")
1424
@dbus.service.signal(_interface, signature="tb")
876
1425
def NeedApproval(self, timeout, default):
877
1426
"D-Bus signal"
878
pass
1427
return self.need_approval()
879
1428
880
1429
## Methods
881
1430
882
1431
# Approve - method
883
@dbus.service.method(_interface, in_signature=u"b")
1432
@dbus.service.method(_interface, in_signature="b")
884
1433
def Approve(self, value):
885
1434
self.approve(value)
886
1435
887
1436
# CheckedOK - method
888
1437
@dbus.service.method(_interface)
889
1438
def CheckedOK(self):
890
return self.checked_ok()
1439
self.checked_ok()
891
1440
892
1441
# Enable - method
893
1442
@dbus.service.method(_interface)
914
1463
915
1464
## Properties
916
1465
917
# approved_pending - property
918
@dbus_service_property(_interface, signature=u"b", access=u"read")
919
def approved_pending_dbus_property(self):
1466
# ApprovalPending - property
1467
@dbus_service_property(_interface, signature="b", access="read")
1468
def ApprovalPending_dbus_property(self):
920
1469
return dbus.Boolean(bool(self.approvals_pending))
921
1470
922
# approved_by_default - property
923
@dbus_service_property(_interface, signature=u"b",
924
access=u"readwrite")
925
def approved_by_default_dbus_property(self):
926
return dbus.Boolean(self.approved_by_default)
927
928
# approved_delay - property
929
@dbus_service_property(_interface, signature=u"t",
930
access=u"readwrite")
931
def approved_delay_dbus_property(self):
932
return dbus.UInt64(self.approved_delay_milliseconds())
933
934
# approved_duration - property
935
@dbus_service_property(_interface, signature=u"t",
936
access=u"readwrite")
937
def approved_duration_dbus_property(self):
938
return dbus.UInt64(self._timedelta_to_milliseconds(
939
self.approved_duration))
940
941
# name - property
942
@dbus_service_property(_interface, signature=u"s", access=u"read")
943
def name_dbus_property(self):
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):
944
1500
return dbus.String(self.name)
945
1501
946
# fingerprint - property
947
@dbus_service_property(_interface, signature=u"s", access=u"read")
948
def fingerprint_dbus_property(self):
1502
# Fingerprint - property
1503
@dbus_service_property(_interface, signature="s", access="read")
1504
def Fingerprint_dbus_property(self):
949
1505
return dbus.String(self.fingerprint)
950
1506
951
# host - property
952
@dbus_service_property(_interface, signature=u"s",
953
access=u"readwrite")
954
def host_dbus_property(self, value=None):
1507
# Host - property
1508
@dbus_service_property(_interface, signature="s",
1509
access="readwrite")
1510
def Host_dbus_property(self, value=None):
955
1511
if value is None: # get
956
1512
return dbus.String(self.host)
957
self.host = value
958
# Emit D-Bus signal
959
self.PropertyChanged(dbus.String(u"host"),
960
dbus.String(value, variant_level=1))
961
962
# created - property
963
@dbus_service_property(_interface, signature=u"s", access=u"read")
964
def created_dbus_property(self):
965
return dbus.String(self._datetime_to_dbus(self.created))
966
967
# last_enabled - property
968
@dbus_service_property(_interface, signature=u"s", access=u"read")
969
def last_enabled_dbus_property(self):
970
if self.last_enabled is None:
971
return dbus.String(u"")
972
return dbus.String(self._datetime_to_dbus(self.last_enabled))
973
974
# enabled - property
975
@dbus_service_property(_interface, signature=u"b",
976
access=u"readwrite")
977
def enabled_dbus_property(self, value=None):
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):
978
1529
if value is None: # get
979
1530
return dbus.Boolean(self.enabled)
980
1531
if value:
982
1533
else:
983
1534
self.disable()
984
1535
985
# last_checked_ok - property
986
@dbus_service_property(_interface, signature=u"s",
987
access=u"readwrite")
988
def last_checked_ok_dbus_property(self, value=None):
1536
# LastCheckedOK - property
1537
@dbus_service_property(_interface, signature="s",
1538
access="readwrite")
1539
def LastCheckedOK_dbus_property(self, value=None):
989
1540
if value is not None:
990
1541
self.checked_ok()
991
1542
return
992
if self.last_checked_ok is None:
993
return dbus.String(u"")
994
return dbus.String(self._datetime_to_dbus(self
995
.last_checked_ok))
996
997
# timeout - property
998
@dbus_service_property(_interface, signature=u"t",
999
access=u"readwrite")
1000
def timeout_dbus_property(self, value=None):
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):
1001
1565
if value is None: # get
1002
return dbus.UInt64(self.timeout_milliseconds())
1566
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1567
old_timeout = self.timeout
1003
1568
self.timeout = datetime.timedelta(0, 0, 0, value)
1004
# Emit D-Bus signal
1005
self.PropertyChanged(dbus.String(u"timeout"),
1006
dbus.UInt64(value, variant_level=1))
1007
if getattr(self, u"disable_initiator_tag", None) is None:
1008
return
1009
# Reschedule timeout
1010
gobject.source_remove(self.disable_initiator_tag)
1011
self.disable_initiator_tag = None
1012
time_to_die = (self.
1013
_timedelta_to_milliseconds((self
1014
.last_checked_ok
1015
+ self.timeout)
1016
- datetime.datetime
1017
.utcnow()))
1018
if time_to_die <= 0:
1019
# The timeout has passed
1020
self.disable()
1021
else:
1022
self.disable_initiator_tag = (gobject.timeout_add
1023
(time_to_die, self.disable))
1024
1025
# interval - property
1026
@dbus_service_property(_interface, signature=u"t",
1027
access=u"readwrite")
1028
def interval_dbus_property(self, value=None):
1029
if value is None: # get
1030
return dbus.UInt64(self.interval_milliseconds())
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)
1031
1601
self.interval = datetime.timedelta(0, 0, 0, value)
1032
# Emit D-Bus signal
1033
self.PropertyChanged(dbus.String(u"interval"),
1034
dbus.UInt64(value, variant_level=1))
1035
if getattr(self, u"checker_initiator_tag", None) is None:
1602
if getattr(self, "checker_initiator_tag", None) is None:
1036
1603
return
1037
# Reschedule checker run
1038
gobject.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = (gobject.timeout_add
1040
(value, self.start_checker))
1041
self.start_checker() # Start one now, too
1042
1043
# checker - property
1044
@dbus_service_property(_interface, signature=u"s",
1045
access=u"readwrite")
1046
def checker_dbus_property(self, value=None):
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):
1047
1615
if value is None: # get
1048
1616
return dbus.String(self.checker_command)
1049
self.checker_command = value
1050
# Emit D-Bus signal
1051
self.PropertyChanged(dbus.String(u"checker"),
1052
dbus.String(self.checker_command,
1053
variant_level=1))
1617
self.checker_command = str(value)
1054
1618
1055
# checker_running - property
1056
@dbus_service_property(_interface, signature=u"b",
1057
access=u"readwrite")
1058
def checker_running_dbus_property(self, value=None):
1619
# CheckerRunning - property
1620
@dbus_service_property(_interface, signature="b",
1621
access="readwrite")
1622
def CheckerRunning_dbus_property(self, value=None):
1059
1623
if value is None: # get
1060
1624
return dbus.Boolean(self.checker is not None)
1061
1625
if value:
1063
1627
else:
1064
1628
self.stop_checker()
1065
1629
1066
# object_path - property
1067
@dbus_service_property(_interface, signature=u"o", access=u"read")
1068
def object_path_dbus_property(self):
1630
# ObjectPath - property
1631
@dbus_service_property(_interface, signature="o", access="read")
1632
def ObjectPath_dbus_property(self):
1069
1633
return self.dbus_object_path # is already a dbus.ObjectPath
1070
1634
1071
# secret = property
1072
@dbus_service_property(_interface, signature=u"ay",
1073
access=u"write", byte_arrays=True)
1074
def secret_dbus_property(self, value):
1075
self.secret = str(value)
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)
1076
1640
1077
1641
del _interface
1078
1642
1083
1647
self._pipe.send(('init', fpr, address))
1084
1648
if not self._pipe.recv():
1085
1649
raise KeyError()
1086
1650
1087
1651
def __getattribute__(self, name):
1088
if(name == '_pipe'):
1652
if name == '_pipe':
1089
1653
return super(ProxyClient, self).__getattribute__(name)
1090
1654
self._pipe.send(('getattr', name))
1091
1655
data = self._pipe.recv()
1096
1660
self._pipe.send(('funcall', name, args, kwargs))
1097
1661
return self._pipe.recv()[1]
1098
1662
return func
1099
1663
1100
1664
def __setattr__(self, name, value):
1101
if(name == '_pipe'):
1665
if name == '_pipe':
1102
1666
return super(ProxyClient, self).__setattr__(name, value)
1103
1667
self._pipe.send(('setattr', name, value))
1104
1668
1111
1675
1112
1676
def handle(self):
1113
1677
with contextlib.closing(self.server.child_pipe) as child_pipe:
1114
logger.info(u"TCP connection from: %s",
1115
unicode(self.client_address))
1116
logger.debug(u"Pipe FD: %d",
1678
logger.info("TCP connection from: %s",
1679
str(self.client_address))
1680
logger.debug("Pipe FD: %d",
1117
1681
self.server.child_pipe.fileno())
1118
1682
1119
1683
session = (gnutls.connection
1120
1684
.ClientSession(self.request,
1121
1685
gnutls.connection
1122
1686
.X509Credentials()))
1123
1687
1124
1688
# Note: gnutls.connection.X509Credentials is really a
1125
1689
# generic GnuTLS certificate credentials object so long as
1126
1690
# no X.509 keys are added to it. Therefore, we can use it
1127
1691
# here despite using OpenPGP certificates.
1128
1129
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1130
# u"+AES-256-CBC", u"+SHA1",
1131
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1132
# u"+DHE-DSS"))
1692
1693
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1694
# "+AES-256-CBC", "+SHA1",
1695
# "+COMP-NULL", "+CTYPE-OPENPGP",
1696
# "+DHE-DSS"))
1133
1697
# Use a fallback default, since this MUST be set.
1134
1698
priority = self.server.gnutls_priority
1135
1699
if priority is None:
1136
priority = u"NORMAL"
1700
priority = "NORMAL"
1137
1701
(gnutls.library.functions
1138
1702
.gnutls_priority_set_direct(session._c_object,
1139
1703
priority, None))
1140
1704
1141
1705
# Start communication using the Mandos protocol
1142
1706
# Get protocol number
1143
1707
line = self.request.makefile().readline()
1144
logger.debug(u"Protocol version: %r", line)
1708
logger.debug("Protocol version: %r", line)
1145
1709
try:
1146
1710
if int(line.strip().split()[0]) > 1:
1147
raise RuntimeError
1148
except (ValueError, IndexError, RuntimeError), error:
1149
logger.error(u"Unknown protocol version: %s", error)
1711
raise RuntimeError(line)
1712
except (ValueError, IndexError, RuntimeError) as error:
1713
logger.error("Unknown protocol version: %s", error)
1150
1714
return
1151
1715
1152
1716
# Start GnuTLS connection
1153
1717
try:
1154
1718
session.handshake()
1155
except gnutls.errors.GNUTLSError, error:
1156
logger.warning(u"Handshake failed: %s", error)
1719
except gnutls.errors.GNUTLSError as error:
1720
logger.warning("Handshake failed: %s", error)
1157
1721
# Do not run session.bye() here: the session is not
1158
1722
# established. Just abandon the request.
1159
1723
return
1160
logger.debug(u"Handshake succeeded")
1161
1724
logger.debug("Handshake succeeded")
1725
1162
1726
approval_required = False
1163
1727
try:
1164
1728
try:
1165
1729
fpr = self.fingerprint(self.peer_certificate
1166
1730
(session))
1167
except (TypeError, gnutls.errors.GNUTLSError), error:
1168
logger.warning(u"Bad certificate: %s", error)
1731
except (TypeError,
1732
gnutls.errors.GNUTLSError) as error:
1733
logger.warning("Bad certificate: %s", error)
1169
1734
return
1170
logger.debug(u"Fingerprint: %s", fpr)
1171
1735
logger.debug("Fingerprint: %s", fpr)
1736
1172
1737
try:
1173
1738
client = ProxyClient(child_pipe, fpr,
1174
1739
self.client_address)
1175
1740
except KeyError:
1176
1741
return
1177
1742
1178
if client.approved_delay:
1179
delay = client.approved_delay
1743
if client.approval_delay:
1744
delay = client.approval_delay
1180
1745
client.approvals_pending += 1
1181
1746
approval_required = True
1182
1747
1183
1748
while True:
1184
1749
if not client.enabled:
1185
logger.warning(u"Client %s is disabled",
1750
logger.info("Client %s is disabled",
1186
1751
client.name)
1187
1752
if self.server.use_dbus:
1188
1753
# Emit D-Bus signal
1189
client.Rejected("Disabled")
1754
client.Rejected("Disabled")
1190
1755
return
1191
1756
1192
if client._approved or not client.approved_delay:
1757
if client.approved or not client.approval_delay:
1193
1758
#We are approved or approval is disabled
1194
1759
break
1195
elif client._approved is None:
1196
logger.info(u"Client %s need approval",
1760
elif client.approved is None:
1761
logger.info("Client %s needs approval",
1197
1762
client.name)
1198
1763
if self.server.use_dbus:
1199
1764
# Emit D-Bus signal
1200
1765
client.NeedApproval(
1201
client.approved_delay_milliseconds(),
1202
client.approved_by_default)
1766
client.approval_delay.total_seconds()
1767
* 1000, client.approved_by_default)
1203
1768
else:
1204
logger.warning(u"Client %s was not approved",
1769
logger.warning("Client %s was not approved",
1205
1770
client.name)
1206
1771
if self.server.use_dbus:
1207
1772
# Emit D-Bus signal
1208
client.Rejected("Disapproved")
1773
client.Rejected("Denied")
1209
1774
return
1210
1775
1211
1776
#wait until timeout or approved
1212
#x = float(client._timedelta_to_milliseconds(delay))
1213
1777
time = datetime.datetime.now()
1214
1778
client.changedstate.acquire()
1215
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1779
client.changedstate.wait(delay.total_seconds())
1216
1780
client.changedstate.release()
1217
1781
time2 = datetime.datetime.now()
1218
1782
if (time2 - time) >= delay:
1222
1786
client.name)
1223
1787
if self.server.use_dbus:
1224
1788
# Emit D-Bus signal
1225
client.Rejected("Time out")
1789
client.Rejected("Approval timed out")
1226
1790
return
1227
1791
else:
1228
1792
break
1233
1797
while sent_size < len(client.secret):
1234
1798
try:
1235
1799
sent = session.send(client.secret[sent_size:])
1236
except (gnutls.errors.GNUTLSError), error:
1237
logger.warning("gnutls send failed")
1800
except gnutls.errors.GNUTLSError as error:
1801
logger.warning("gnutls send failed",
1802
exc_info=error)
1238
1803
return
1239
logger.debug(u"Sent: %d, remaining: %d",
1804
logger.debug("Sent: %d, remaining: %d",
1240
1805
sent, len(client.secret)
1241
1806
- (sent_size + sent))
1242
1807
sent_size += sent
1243
1244
logger.info(u"Sending secret to %s", client.name)
1245
# bump the timeout as if seen
1246
client.checked_ok()
1808
1809
logger.info("Sending secret to %s", client.name)
1810
# bump the timeout using extended_timeout
1811
client.bump_timeout(client.extended_timeout)
1247
1812
if self.server.use_dbus:
1248
1813
# Emit D-Bus signal
1249
1814
client.GotSecret()
1253
1818
client.approvals_pending -= 1
1254
1819
try:
1255
1820
session.bye()
1256
except (gnutls.errors.GNUTLSError), error:
1257
logger.warning("gnutls bye failed")
1821
except gnutls.errors.GNUTLSError as error:
1822
logger.warning("GnuTLS bye failed",
1823
exc_info=error)
1258
1824
1259
1825
@staticmethod
1260
1826
def peer_certificate(session):
1270
1836
.gnutls_certificate_get_peers
1271
1837
(session._c_object, ctypes.byref(list_size)))
1272
1838
if not bool(cert_list) and list_size.value != 0:
1273
raise gnutls.errors.GNUTLSError(u"error getting peer"
1274
u" certificate")
1839
raise gnutls.errors.GNUTLSError("error getting peer"
1840
" certificate")
1275
1841
if list_size.value == 0:
1276
1842
return None
1277
1843
cert = cert_list[0]
1303
1869
if crtverify.value != 0:
1304
1870
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1305
1871
raise (gnutls.errors.CertificateSecurityError
1306
(u"Verify failed"))
1872
("Verify failed"))
1307
1873
# New buffer for the fingerprint
1308
1874
buf = ctypes.create_string_buffer(20)
1309
1875
buf_len = ctypes.c_size_t()
1316
1882
# Convert the buffer to a Python bytestring
1317
1883
fpr = ctypes.string_at(buf, buf_len.value)
1318
1884
# Convert the bytestring to hexadecimal notation
1319
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1885
hex_fpr = binascii.hexlify(fpr).upper()
1320
1886
return hex_fpr
1321
1887
1322
1888
1325
1891
def sub_process_main(self, request, address):
1326
1892
try:
1327
1893
self.finish_request(request, address)
1328
except:
1894
except Exception:
1329
1895
self.handle_error(request, address)
1330
1896
self.close_request(request)
1331
1897
1332
1898
def process_request(self, request, address):
1333
1899
"""Start a new process to process the request."""
1334
multiprocessing.Process(target = self.sub_process_main,
1335
args = (request, address)).start()
1900
proc = multiprocessing.Process(target = self.sub_process_main,
1901
args = (request, address))
1902
proc.start()
1903
return proc
1904
1336
1905
1337
1906
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1338
1907
""" adds a pipe to the MixIn """
1342
1911
This function creates a new pipe in self.pipe
1343
1912
"""
1344
1913
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1345
1346
super(MultiprocessingMixInWithPipe,
1347
self).process_request(request, client_address)
1914
1915
proc = MultiprocessingMixIn.process_request(self, request,
1916
client_address)
1348
1917
self.child_pipe.close()
1349
self.add_pipe(parent_pipe)
1350
1351
def add_pipe(self, parent_pipe):
1918
self.add_pipe(parent_pipe, proc)
1919
1920
def add_pipe(self, parent_pipe, proc):
1352
1921
"""Dummy function; override as necessary"""
1353
pass
1922
raise NotImplementedError()
1923
1354
1924
1355
1925
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1356
1926
socketserver.TCPServer, object):
1362
1932
use_ipv6: Boolean; to use IPv6 or not
1363
1933
"""
1364
1934
def __init__(self, server_address, RequestHandlerClass,
1365
interface=None, use_ipv6=True):
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
"""
1366
1939
self.interface = interface
1367
1940
if use_ipv6:
1368
1941
self.address_family = socket.AF_INET6
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.
1369
1968
socketserver.TCPServer.__init__(self, server_address,
1370
1969
RequestHandlerClass)
1970
1371
1971
def server_bind(self):
1372
1972
"""This overrides the normal server_bind() function
1373
1973
to bind to an interface if one was specified, and also NOT to
1374
1974
bind to an address or port if they were not specified."""
1375
1975
if self.interface is not None:
1376
1976
if SO_BINDTODEVICE is None:
1377
logger.error(u"SO_BINDTODEVICE does not exist;"
1378
u" cannot bind to interface %s",
1977
logger.error("SO_BINDTODEVICE does not exist;"
1978
" cannot bind to interface %s",
1379
1979
self.interface)
1380
1980
else:
1381
1981
try:
1382
1982
self.socket.setsockopt(socket.SOL_SOCKET,
1383
1983
SO_BINDTODEVICE,
1384
str(self.interface
1385
+ u'\0'))
1386
except socket.error, error:
1387
if error[0] == errno.EPERM:
1388
logger.error(u"No permission to"
1389
u" bind to interface %s",
1390
self.interface)
1391
elif error[0] == errno.ENOPROTOOPT:
1392
logger.error(u"SO_BINDTODEVICE not available;"
1393
u" cannot bind to interface %s",
1394
self.interface)
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)
1395
1997
else:
1396
1998
raise
1397
1999
# Only bind(2) the socket if we really need to.
1398
2000
if self.server_address[0] or self.server_address[1]:
1399
2001
if not self.server_address[0]:
1400
2002
if self.address_family == socket.AF_INET6:
1401
any_address = u"::" # in6addr_any
2003
any_address = "::" # in6addr_any
1402
2004
else:
1403
any_address = socket.INADDR_ANY
2005
any_address = "0.0.0.0" # INADDR_ANY
1404
2006
self.server_address = (any_address,
1405
2007
self.server_address[1])
1406
2008
elif not self.server_address[1]:
1427
2029
"""
1428
2030
def __init__(self, server_address, RequestHandlerClass,
1429
2031
interface=None, use_ipv6=True, clients=None,
1430
gnutls_priority=None, use_dbus=True):
2032
gnutls_priority=None, use_dbus=True, socketfd=None):
1431
2033
self.enabled = False
1432
2034
self.clients = clients
1433
2035
if self.clients is None:
1434
self.clients = set()
2036
self.clients = {}
1435
2037
self.use_dbus = use_dbus
1436
2038
self.gnutls_priority = gnutls_priority
1437
2039
IPv6_TCPServer.__init__(self, server_address,
1438
2040
RequestHandlerClass,
1439
2041
interface = interface,
1440
use_ipv6 = use_ipv6)
2042
use_ipv6 = use_ipv6,
2043
socketfd = socketfd)
1441
2044
def server_activate(self):
1442
2045
if self.enabled:
1443
2046
return socketserver.TCPServer.server_activate(self)
2047
1444
2048
def enable(self):
1445
2049
self.enabled = True
1446
def add_pipe(self, parent_pipe):
2050
2051
def add_pipe(self, parent_pipe, proc):
1447
2052
# Call "handle_ipc" for both data and EOF events
1448
2053
gobject.io_add_watch(parent_pipe.fileno(),
1449
2054
gobject.IO_IN | gobject.IO_HUP,
1450
2055
functools.partial(self.handle_ipc,
1451
parent_pipe = parent_pipe))
1452
2056
parent_pipe =
2057
parent_pipe,
2058
proc = proc))
2059
1453
2060
def handle_ipc(self, source, condition, parent_pipe=None,
1454
client_object=None):
1455
condition_names = {
1456
gobject.IO_IN: u"IN", # There is data to read.
1457
gobject.IO_OUT: u"OUT", # Data can be written (without
1458
# blocking).
1459
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1460
gobject.IO_ERR: u"ERR", # Error condition.
1461
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1462
# broken, usually for pipes and
1463
# sockets).
1464
}
1465
conditions_string = ' | '.join(name
1466
for cond, name in
1467
condition_names.iteritems()
1468
if cond & condition)
1469
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1470
conditions_string)
1471
1472
# error or the other end of multiprocessing.Pipe has closed
1473
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
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()
1474
2066
return False
1475
2067
1476
2068
# Read a request from the child
1477
2069
request = parent_pipe.recv()
1478
logger.debug(u"IPC request: %s", repr(request))
1479
2070
command = request[0]
1480
2071
1481
2072
if command == 'init':
1482
2073
fpr = request[1]
1483
2074
address = request[2]
1484
2075
1485
for c in self.clients:
2076
for c in self.clients.itervalues():
1486
2077
if c.fingerprint == fpr:
1487
2078
client = c
1488
2079
break
1489
2080
else:
1490
logger.warning(u"Client not found for fingerprint: %s, ad"
1491
u"dress: %s", fpr, address)
2081
logger.info("Client not found for fingerprint: %s, ad"
2082
"dress: %s", fpr, address)
1492
2083
if self.use_dbus:
1493
2084
# Emit D-Bus signal
1494
mandos_dbus_service.ClientNotFound(fpr, address)
2085
mandos_dbus_service.ClientNotFound(fpr,
2086
address[0])
1495
2087
parent_pipe.send(False)
1496
2088
return False
1497
2089
1498
2090
gobject.io_add_watch(parent_pipe.fileno(),
1499
2091
gobject.IO_IN | gobject.IO_HUP,
1500
2092
functools.partial(self.handle_ipc,
1501
parent_pipe = parent_pipe,
1502
client_object = client))
2093
parent_pipe =
2094
parent_pipe,
2095
proc = proc,
2096
client_object =
2097
client))
1503
2098
parent_pipe.send(True)
1504
# remove the old hook in favor of the new above hook on same fileno
2099
# remove the old hook in favor of the new above hook on
2100
# same fileno
1505
2101
return False
1506
2102
if command == 'funcall':
1507
2103
funcname = request[1]
1508
2104
args = request[2]
1509
2105
kwargs = request[3]
1510
2106
1511
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1512
2107
parent_pipe.send(('data', getattr(client_object,
2108
funcname)(*args,
2109
**kwargs)))
2110
1513
2111
if command == 'getattr':
1514
2112
attrname = request[1]
1515
2113
if callable(client_object.__getattribute__(attrname)):
1516
2114
parent_pipe.send(('function',))
1517
2115
else:
1518
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2116
parent_pipe.send(('data', client_object
2117
.__getattribute__(attrname)))
1519
2118
1520
2119
if command == 'setattr':
1521
2120
attrname = request[1]
1522
2121
value = request[2]
1523
2122
setattr(client_object, attrname, value)
1524
2123
1525
2124
return True
1526
2125
1527
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
2219
else:
2220
# No currently valid tokens were found
2221
raise ValueError("Invalid RFC 3339 duration")
2222
# End token found
2223
return value
2224
2225
1528
2226
def string_to_delta(interval):
1529
2227
"""Parse a string and return a datetime.timedelta
1530
2228
1531
>>> string_to_delta(u'7d')
2229
>>> string_to_delta('7d')
1532
2230
datetime.timedelta(7)
1533
>>> string_to_delta(u'60s')
2231
>>> string_to_delta('60s')
1534
2232
datetime.timedelta(0, 60)
1535
>>> string_to_delta(u'60m')
2233
>>> string_to_delta('60m')
1536
2234
datetime.timedelta(0, 3600)
1537
>>> string_to_delta(u'24h')
2235
>>> string_to_delta('24h')
1538
2236
datetime.timedelta(1)
1539
>>> string_to_delta(u'1w')
2237
>>> string_to_delta('1w')
1540
2238
datetime.timedelta(7)
1541
>>> string_to_delta(u'5m 30s')
2239
>>> string_to_delta('5m 30s')
1542
2240
datetime.timedelta(0, 330)
1543
2241
"""
2242
2243
try:
2244
return rfc3339_duration_to_delta(interval)
2245
except ValueError:
2246
pass
2247
1544
2248
timevalue = datetime.timedelta(0)
1545
2249
for s in interval.split():
1546
2250
try:
1547
suffix = unicode(s[-1])
2251
suffix = s[-1]
1548
2252
value = int(s[:-1])
1549
if suffix == u"d":
2253
if suffix == "d":
1550
2254
delta = datetime.timedelta(value)
1551
elif suffix == u"s":
2255
elif suffix == "s":
1552
2256
delta = datetime.timedelta(0, value)
1553
elif suffix == u"m":
2257
elif suffix == "m":
1554
2258
delta = datetime.timedelta(0, 0, 0, 0, value)
1555
elif suffix == u"h":
2259
elif suffix == "h":
1556
2260
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1557
elif suffix == u"w":
2261
elif suffix == "w":
1558
2262
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1559
2263
else:
1560
raise ValueError(u"Unknown suffix %r" % suffix)
1561
except (ValueError, IndexError), e:
1562
raise ValueError(e.message)
2264
raise ValueError("Unknown suffix {!r}"
2265
.format(suffix))
2266
except IndexError as e:
2267
raise ValueError(*(e.args))
1563
2268
timevalue += delta
1564
2269
return timevalue
1565
2270
1566
2271
1567
def if_nametoindex(interface):
1568
"""Call the C function if_nametoindex(), or equivalent
1569
1570
Note: This function cannot accept a unicode string."""
1571
global if_nametoindex
1572
try:
1573
if_nametoindex = (ctypes.cdll.LoadLibrary
1574
(ctypes.util.find_library(u"c"))
1575
.if_nametoindex)
1576
except (OSError, AttributeError):
1577
logger.warning(u"Doing if_nametoindex the hard way")
1578
def if_nametoindex(interface):
1579
"Get an interface index the hard way, i.e. using fcntl()"
1580
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1581
with contextlib.closing(socket.socket()) as s:
1582
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1583
struct.pack(str(u"16s16x"),
1584
interface))
1585
interface_index = struct.unpack(str(u"I"),
1586
ifreq[16:20])[0]
1587
return interface_index
1588
return if_nametoindex(interface)
1589
1590
1591
2272
def daemon(nochdir = False, noclose = False):
1592
2273
"""See daemon(3). Standard BSD Unix function.
1593
2274
1596
2277
sys.exit()
1597
2278
os.setsid()
1598
2279
if not nochdir:
1599
os.chdir(u"/")
2280
os.chdir("/")
1600
2281
if os.fork():
1601
2282
sys.exit()
1602
2283
if not noclose:
1603
2284
# Close all standard open file descriptors
1604
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2285
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1605
2286
if not stat.S_ISCHR(os.fstat(null).st_mode):
1606
raise OSError(errno.ENODEV,
1607
u"%s not a character device"
1608
% os.path.devnull)
2287
raise OSError(errno.ENODEV, "{} not a character device"
2288
.format(os.devnull))
1609
2289
os.dup2(null, sys.stdin.fileno())
1610
2290
os.dup2(null, sys.stdout.fileno())
1611
2291
os.dup2(null, sys.stderr.fileno())
1618
2298
##################################################################
1619
2299
# Parsing of options, both command line and config file
1620
2300
1621
parser = optparse.OptionParser(version = "%%prog %s" % version)
1622
parser.add_option("-i", u"--interface", type=u"string",
1623
metavar="IF", help=u"Bind to interface IF")
1624
parser.add_option("-a", u"--address", type=u"string",
1625
help=u"Address to listen for requests on")
1626
parser.add_option("-p", u"--port", type=u"int",
1627
help=u"Port number to receive requests on")
1628
parser.add_option("--check", action=u"store_true",
1629
help=u"Run self-test")
1630
parser.add_option("--debug", action=u"store_true",
1631
help=u"Debug mode; run in foreground and log to"
1632
u" terminal")
1633
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1634
help=u"Debug level for stdout output")
1635
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1636
u" priority string (see GnuTLS documentation)")
1637
parser.add_option("--servicename", type=u"string",
1638
metavar=u"NAME", help=u"Zeroconf service name")
1639
parser.add_option("--configdir", type=u"string",
1640
default=u"/etc/mandos", metavar=u"DIR",
1641
help=u"Directory to search for configuration"
1642
u" files")
1643
parser.add_option("--no-dbus", action=u"store_false",
1644
dest=u"use_dbus", help=u"Do not provide D-Bus"
1645
u" system bus interface")
1646
parser.add_option("--no-ipv6", action=u"store_false",
1647
dest=u"use_ipv6", help=u"Do not use IPv6")
1648
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()
1649
2347
1650
2348
if options.check:
1651
2349
import doctest
1652
doctest.testmod()
1653
sys.exit()
2350
fail_count, test_count = doctest.testmod()
2351
sys.exit(os.EX_OK if fail_count == 0 else 1)
1654
2352
1655
2353
# Default values for config file for server-global settings
1656
server_defaults = { u"interface": u"",
1657
u"address": u"",
1658
u"port": u"",
1659
u"debug": u"False",
1660
u"priority":
1661
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1662
u"servicename": u"Mandos",
1663
u"use_dbus": u"True",
1664
u"use_ipv6": u"True",
1665
u"debuglevel": u"",
2354
server_defaults = { "interface": "",
2355
"address": "",
2356
"port": "",
2357
"debug": "False",
2358
"priority":
2359
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2360
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2361
"servicename": "Mandos",
2362
"use_dbus": "True",
2363
"use_ipv6": "True",
2364
"debuglevel": "",
2365
"restore": "True",
2366
"socket": "",
2367
"statedir": "/var/lib/mandos",
2368
"foreground": "False",
2369
"zeroconf": "True",
1666
2370
}
1667
2371
1668
2372
# Parse config file for server-global settings
1669
2373
server_config = configparser.SafeConfigParser(server_defaults)
1670
2374
del server_defaults
1671
2375
server_config.read(os.path.join(options.configdir,
1672
u"mandos.conf"))
2376
"mandos.conf"))
1673
2377
# Convert the SafeConfigParser object to a dict
1674
2378
server_settings = server_config.defaults()
1675
2379
# Use the appropriate methods on the non-string config options
1676
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1677
server_settings[option] = server_config.getboolean(u"DEFAULT",
2380
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2381
server_settings[option] = server_config.getboolean("DEFAULT",
1678
2382
option)
1679
2383
if server_settings["port"]:
1680
server_settings["port"] = server_config.getint(u"DEFAULT",
1681
u"port")
2384
server_settings["port"] = server_config.getint("DEFAULT",
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"])
1682
2395
del server_config
1683
2396
1684
2397
# Override the settings from the config file with command line
1685
2398
# options, if set.
1686
for option in (u"interface", u"address", u"port", u"debug",
1687
u"priority", u"servicename", u"configdir",
1688
u"use_dbus", u"use_ipv6", u"debuglevel"):
2399
for option in ("interface", "address", "port", "debug",
2400
"priority", "servicename", "configdir",
2401
"use_dbus", "use_ipv6", "debuglevel", "restore",
2402
"statedir", "socket", "foreground", "zeroconf"):
1689
2403
value = getattr(options, option)
1690
2404
if value is not None:
1691
2405
server_settings[option] = value
1692
2406
del options
1693
2407
# Force all strings to be unicode
1694
2408
for option in server_settings.keys():
1695
if type(server_settings[option]) is str:
1696
server_settings[option] = unicode(server_settings[option])
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
1697
2419
# Now we have our good server settings in "server_settings"
1698
2420
1699
2421
##################################################################
1700
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
1701
2429
# For convenience
1702
debug = server_settings[u"debug"]
1703
debuglevel = server_settings[u"debuglevel"]
1704
use_dbus = server_settings[u"use_dbus"]
1705
use_ipv6 = server_settings[u"use_ipv6"]
1706
1707
if server_settings[u"servicename"] != u"Mandos":
2430
debug = server_settings["debug"]
2431
debuglevel = server_settings["debuglevel"]
2432
use_dbus = server_settings["use_dbus"]
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"]
2438
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)
2447
2448
if server_settings["servicename"] != "Mandos":
1708
2449
syslogger.setFormatter(logging.Formatter
1709
(u'Mandos (%s) [%%(process)d]:'
1710
u' %%(levelname)s: %%(message)s'
1711
% server_settings[u"servicename"]))
2450
('Mandos ({}) [%(process)d]:'
2451
' %(levelname)s: %(message)s'
2452
.format(server_settings
2453
["servicename"])))
1712
2454
1713
2455
# Parse config file with clients
1714
client_defaults = { u"timeout": u"1h",
1715
u"interval": u"5m",
1716
u"checker": u"fping -q -- %%(host)s",
1717
u"host": u"",
1718
u"approved_delay": u"0s",
1719
u"approved_duration": u"1s",
1720
}
1721
client_config = configparser.SafeConfigParser(client_defaults)
1722
client_config.read(os.path.join(server_settings[u"configdir"],
1723
u"clients.conf"))
2456
client_config = configparser.SafeConfigParser(Client
2457
.client_defaults)
2458
client_config.read(os.path.join(server_settings["configdir"],
2459
"clients.conf"))
1724
2460
1725
2461
global mandos_dbus_service
1726
2462
mandos_dbus_service = None
1727
2463
1728
tcp_server = MandosServer((server_settings[u"address"],
1729
server_settings[u"port"]),
2464
socketfd = None
2465
if server_settings["socket"] != "":
2466
socketfd = server_settings["socket"]
2467
tcp_server = MandosServer((server_settings["address"],
2468
server_settings["port"]),
1730
2469
ClientHandler,
1731
interface=server_settings[u"interface"],
2470
interface=(server_settings["interface"]
2471
or None),
1732
2472
use_ipv6=use_ipv6,
1733
2473
gnutls_priority=
1734
server_settings[u"priority"],
1735
use_dbus=use_dbus)
1736
pidfilename = u"/var/run/mandos.pid"
1737
try:
1738
pidfile = open(pidfilename, u"w")
1739
except IOError:
1740
logger.error(u"Could not open file %r", pidfilename)
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)
1741
2487
1742
try:
1743
uid = pwd.getpwnam(u"_mandos").pw_uid
1744
gid = pwd.getpwnam(u"_mandos").pw_gid
1745
except KeyError:
2488
for name in ("_mandos", "mandos", "nobody"):
1746
2489
try:
1747
uid = pwd.getpwnam(u"mandos").pw_uid
1748
gid = pwd.getpwnam(u"mandos").pw_gid
2490
uid = pwd.getpwnam(name).pw_uid
2491
gid = pwd.getpwnam(name).pw_gid
2492
break
1749
2493
except KeyError:
1750
try:
1751
uid = pwd.getpwnam(u"nobody").pw_uid
1752
gid = pwd.getpwnam(u"nobody").pw_gid
1753
except KeyError:
1754
uid = 65534
1755
gid = 65534
2494
continue
2495
else:
2496
uid = 65534
2497
gid = 65534
1756
2498
try:
1757
2499
os.setgid(gid)
1758
2500
os.setuid(uid)
1759
except OSError, error:
1760
if error[0] != errno.EPERM:
1761
raise error
2501
except OSError as error:
2502
if error.errno != errno.EPERM:
2503
raise
1762
2504
1763
# Enable all possible GnuTLS debugging
1764
1765
1766
if not debug and not debuglevel:
1767
syslogger.setLevel(logging.WARNING)
1768
console.setLevel(logging.WARNING)
1769
if debuglevel:
1770
level = getattr(logging, debuglevel.upper())
1771
syslogger.setLevel(level)
1772
console.setLevel(level)
1773
1774
2505
if debug:
2506
# Enable all possible GnuTLS debugging
2507
1775
2508
# "Use a log level over 10 to enable all debugging options."
1776
2509
# - GnuTLS manual
1777
2510
gnutls.library.functions.gnutls_global_set_log_level(11)
1778
2511
1779
2512
@gnutls.library.types.gnutls_log_func
1780
2513
def debug_gnutls(level, string):
1781
logger.debug(u"GnuTLS: %s", string[:-1])
2514
logger.debug("GnuTLS: %s", string[:-1])
1782
2515
1783
2516
(gnutls.library.functions
1784
2517
.gnutls_global_set_log_function(debug_gnutls))
1785
2518
1786
2519
# Redirect stdin so all checkers get /dev/null
1787
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2520
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1788
2521
os.dup2(null, sys.stdin.fileno())
1789
2522
if null > 2:
1790
2523
os.close(null)
1791
else:
1792
# No console logging
1793
logger.removeHandler(console)
1794
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()
1795
2533
1796
2534
global main_loop
1797
2535
# From the Avahi example code
1798
DBusGMainLoop(set_as_default=True )
2536
DBusGMainLoop(set_as_default=True)
1799
2537
main_loop = gobject.MainLoop()
1800
2538
bus = dbus.SystemBus()
1801
2539
# End of Avahi example code
1802
2540
if use_dbus:
1803
2541
try:
1804
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2542
bus_name = dbus.service.BusName("se.recompile.Mandos",
1805
2543
bus, do_not_queue=True)
1806
except dbus.exceptions.NameExistsException, e:
1807
logger.error(unicode(e) + u", disabling D-Bus")
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)
1808
2549
use_dbus = False
1809
server_settings[u"use_dbus"] = False
2550
server_settings["use_dbus"] = False
1810
2551
tcp_server.use_dbus = False
1811
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1812
service = AvahiService(name = server_settings[u"servicename"],
1813
servicetype = u"_mandos._tcp",
1814
protocol = protocol, bus = bus)
1815
if server_settings["interface"]:
1816
service.interface = (if_nametoindex
1817
(str(server_settings[u"interface"])))
1818
1819
if not debug:
1820
# Close all input and output, do double fork, etc.
1821
daemon()
1822
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
1823
2563
global multiprocessing_manager
1824
2564
multiprocessing_manager = multiprocessing.Manager()
1825
2565
1826
2566
client_class = Client
1827
2567
if use_dbus:
1828
2568
client_class = functools.partial(ClientDBus, bus = bus)
1829
def client_config_items(config, section):
1830
special_settings = {
1831
"approved_by_default":
1832
lambda: config.getboolean(section,
1833
"approved_by_default"),
1834
}
1835
for name, value in config.items(section):
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))
1836
2651
try:
1837
yield (name, special_settings[name]())
1838
except KeyError:
1839
yield (name, value)
1840
1841
tcp_server.clients.update(set(
1842
client_class(name = section,
1843
config= dict(client_config_items(
1844
client_config, section)))
1845
for section in client_config.sections()))
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
1846
2677
if not tcp_server.clients:
1847
logger.warning(u"No clients defined")
1848
1849
try:
1850
with pidfile:
1851
pid = os.getpid()
1852
pidfile.write(str(pid) + "\n")
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)
1853
2689
del pidfile
1854
except IOError:
1855
logger.error(u"Could not write to file %r with PID %d",
1856
pidfilename, pid)
1857
except NameError:
1858
# "pidfile" was never created
1859
pass
1860
del pidfilename
2690
del pidfilename
1861
2691
1862
if not debug:
1863
signal.signal(signal.SIGINT, signal.SIG_IGN)
1864
2692
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1865
2693
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1866
2694
1867
2695
if use_dbus:
1868
class MandosDBusService(dbus.service.Object):
2696
@alternate_dbus_interfaces({"se.recompile.Mandos":
2697
"se.bsnet.fukt.Mandos"})
2698
class MandosDBusService(DBusObjectWithProperties):
1869
2699
"""A D-Bus proxy object"""
1870
2700
def __init__(self):
1871
dbus.service.Object.__init__(self, bus, u"/")
1872
_interface = u"se.bsnet.fukt.Mandos"
1873
1874
@dbus.service.signal(_interface, signature=u"o")
2701
dbus.service.Object.__init__(self, bus, "/")
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")
1875
2711
def ClientAdded(self, objpath):
1876
2712
"D-Bus signal"
1877
2713
pass
1878
2714
1879
@dbus.service.signal(_interface, signature=u"ss")
2715
@dbus.service.signal(_interface, signature="ss")
1880
2716
def ClientNotFound(self, fingerprint, address):
1881
2717
"D-Bus signal"
1882
2718
pass
1883
2719
1884
@dbus.service.signal(_interface, signature=u"os")
2720
@dbus.service.signal(_interface, signature="os")
1885
2721
def ClientRemoved(self, objpath, name):
1886
2722
"D-Bus signal"
1887
2723
pass
1888
2724
1889
@dbus.service.method(_interface, out_signature=u"ao")
2725
@dbus.service.method(_interface, out_signature="ao")
1890
2726
def GetAllClients(self):
1891
2727
"D-Bus method"
1892
2728
return dbus.Array(c.dbus_object_path
1893
for c in tcp_server.clients)
2729
for c in
2730
tcp_server.clients.itervalues())
1894
2731
1895
2732
@dbus.service.method(_interface,
1896
out_signature=u"a{oa{sv}}")
2733
out_signature="a{oa{sv}}")
1897
2734
def GetAllClientsWithProperties(self):
1898
2735
"D-Bus method"
1899
2736
return dbus.Dictionary(
1900
((c.dbus_object_path, c.GetAll(u""))
1901
for c in tcp_server.clients),
1902
signature=u"oa{sv}")
2737
{ c.dbus_object_path: c.GetAll("")
2738
for c in tcp_server.clients.itervalues() },
2739
signature="oa{sv}")
1903
2740
1904
@dbus.service.method(_interface, in_signature=u"o")
2741
@dbus.service.method(_interface, in_signature="o")
1905
2742
def RemoveClient(self, object_path):
1906
2743
"D-Bus method"
1907
for c in tcp_server.clients:
2744
for c in tcp_server.clients.itervalues():
1908
2745
if c.dbus_object_path == object_path:
1909
tcp_server.clients.remove(c)
2746
del tcp_server.clients[c.name]
1910
2747
c.remove_from_connection()
1911
2748
# Don't signal anything except ClientRemoved
1912
2749
c.disable(quiet=True)
1921
2758
1922
2759
def cleanup():
1923
2760
"Cleanup function; run on exit"
1924
service.cleanup()
1925
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
1926
2820
while tcp_server.clients:
1927
client = tcp_server.clients.pop()
2821
name, client = tcp_server.clients.popitem()
1928
2822
if use_dbus:
1929
2823
client.remove_from_connection()
1930
client.disable_hook = None
1931
2824
# Don't signal anything except ClientRemoved
1932
2825
client.disable(quiet=True)
1933
2826
if use_dbus:
1934
2827
# Emit D-Bus signal
1935
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2828
mandos_dbus_service.ClientRemoved(client
2829
.dbus_object_path,
1936
2830
client.name)
2831
client_settings.clear()
1937
2832
1938
2833
atexit.register(cleanup)
1939
2834
1940
for client in tcp_server.clients:
2835
for client in tcp_server.clients.itervalues():
1941
2836
if use_dbus:
1942
2837
# Emit D-Bus signal
1943
2838
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1944
client.enable()
2839
# Need to initiate checking of clients
2840
if client.enabled:
2841
client.init_checker()
1945
2842
1946
2843
tcp_server.enable()
1947
2844
tcp_server.server_activate()
1948
2845
1949
2846
# Find out what port we got
1950
service.port = tcp_server.socket.getsockname()[1]
2847
if zeroconf:
2848
service.port = tcp_server.socket.getsockname()[1]
1951
2849
if use_ipv6:
1952
logger.info(u"Now listening on address %r, port %d,"
1953
" flowinfo %d, scope_id %d"
1954
% 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())
1955
2853
else: # IPv4
1956
logger.info(u"Now listening on address %r, port %d"
1957
% tcp_server.socket.getsockname())
2854
logger.info("Now listening on address %r, port %d",
2855
*tcp_server.socket.getsockname())
1958
2856
1959
2857
#service.interface = tcp_server.socket.getsockname()[3]
1960
2858
1961
2859
try:
1962
# From the Avahi example code
1963
try:
1964
service.activate()
1965
except dbus.exceptions.DBusException, error:
1966
logger.critical(u"DBusException: %s", error)
1967
cleanup()
1968
sys.exit(1)
1969
# 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
1970
2869
1971
2870
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1972
2871
lambda *args, **kwargs:
1973
2872
(tcp_server.handle_request
1974
2873
(*args[2:], **kwargs) or True))
1975
2874
1976
logger.debug(u"Starting main loop")
2875
logger.debug("Starting main loop")
1977
2876
main_loop.run()
1978
except AvahiError, error:
1979
logger.critical(u"AvahiError: %s", error)
2877
except AvahiError as error:
2878
logger.critical("Avahi Error", exc_info=error)
1980
2879
cleanup()
1981
2880
sys.exit(1)
1982
2881
except KeyboardInterrupt:
1983
2882
if debug:
1984
print >> sys.stderr
1985
logger.debug(u"Server received KeyboardInterrupt")
1986
logger.debug(u"Server exiting")
2883
print("", file=sys.stderr)
2884
logger.debug("Server received KeyboardInterrupt")
2885
logger.debug("Server exiting")
1987
2886
# Must run before the D-Bus bus name gets deregistered
1988
2887
cleanup()
1989
2888
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0