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