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