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