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