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