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