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