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