To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 237.7.203
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.203
- Committer: Teddy Hogeborn
- Date: 2014-02-16 03:56:48 UTC
- mto: (237.7.272 trunk)
- mto: This revision was merged to the branch mainline in revision 309.
- Revision ID: teddy@recompile.se-20140216035648-i6rjq2mp8jicxudo
Allow self-tests to run without needing /dev/log.
* mandos (main): Only open /dev/log on initlogger() call.
* mandos (main): Only open /dev/log on initlogger() call.
- files added:
- DBUS-API
- debian/source
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 Björn Påhlsson
14
# Copyright © 2008-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 Björn Påhlsson
16
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
#
31
# Contact the authors at <mandos@fukt.bsnet.se>.
31
# Contact the authors at <mandos@recompile.se>.
32
32
#
33
33
34
from __future__ import division, with_statement, absolute_import
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
36
37
from future_builtins import *
35
38
36
39
import SocketServer as socketserver
37
40
import socket
38
import optparse
41
import argparse
39
42
import datetime
40
43
import errno
41
44
import gnutls.crypto
60
63
import fcntl
61
64
import functools
62
65
import cPickle as pickle
63
import select
66
import multiprocessing
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
import collections
64
72
65
73
import dbus
66
74
import dbus.service
80
88
except ImportError:
81
89
SO_BINDTODEVICE = None
82
90
83
84
version = "1.0.14"
85
86
logger = logging.Logger(u'mandos')
87
syslogger = (logging.handlers.SysLogHandler
88
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
89
address = "/dev/log"))
90
syslogger.setFormatter(logging.Formatter
91
(u'Mandos [%(process)d]: %(levelname)s:'
92
u' %(message)s'))
93
logger.addHandler(syslogger)
94
95
console = logging.StreamHandler()
96
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
97
u' %(levelname)s:'
98
u' %(message)s'))
99
logger.addHandler(console)
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
100
222
101
223
class AvahiError(Exception):
102
224
def __init__(self, value, *args, **kwargs):
118
240
Attributes:
119
241
interface: integer; avahi.IF_UNSPEC or an interface index.
120
242
Used to optionally bind to the specified interface.
121
name: string; Example: u'Mandos'
122
type: string; Example: u'_mandos._tcp'.
123
See <http://www.dns-sd.org/ServiceTypes.html>
243
name: string; Example: 'Mandos'
244
type: string; Example: '_mandos._tcp'.
245
See <https://www.iana.org/assignments/service-names-port-numbers>
124
246
port: integer; what port to announce
125
247
TXT: list of strings; TXT record for the service
126
248
domain: string; Domain to publish on, default to .local if empty.
132
254
server: D-Bus Server
133
255
bus: dbus.SystemBus()
134
256
"""
257
135
258
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
136
259
servicetype = None, port = None, TXT = None,
137
domain = u"", host = u"", max_renames = 32768,
260
domain = "", host = "", max_renames = 32768,
138
261
protocol = avahi.PROTO_UNSPEC, bus = None):
139
262
self.interface = interface
140
263
self.name = name
149
272
self.group = None # our entry group
150
273
self.server = None
151
274
self.bus = bus
275
self.entry_group_state_changed_match = None
276
152
277
def rename(self):
153
278
"""Derived from the Avahi example code"""
154
279
if self.rename_count >= self.max_renames:
155
logger.critical(u"No suitable Zeroconf service name found"
156
u" after %i retries, exiting.",
280
logger.critical("No suitable Zeroconf service name found"
281
" after %i retries, exiting.",
157
282
self.rename_count)
158
raise AvahiServiceError(u"Too many renames")
159
self.name = self.server.GetAlternativeServiceName(self.name)
160
logger.info(u"Changing Zeroconf service name to %r ...",
161
unicode(self.name))
162
syslogger.setFormatter(logging.Formatter
163
(u'Mandos (%s) [%%(process)d]:'
164
u' %%(levelname)s: %%(message)s'
165
% self.name))
283
raise AvahiServiceError("Too many renames")
284
self.name = unicode(self.server
285
.GetAlternativeServiceName(self.name))
286
logger.info("Changing Zeroconf service name to %r ...",
287
self.name)
166
288
self.remove()
167
self.add()
289
try:
290
self.add()
291
except dbus.exceptions.DBusException as error:
292
logger.critical("D-Bus Exception", exc_info=error)
293
self.cleanup()
294
os._exit(1)
168
295
self.rename_count += 1
296
169
297
def remove(self):
170
298
"""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
171
302
if self.group is not None:
172
303
self.group.Reset()
304
173
305
def add(self):
174
306
"""Derived from the Avahi example code"""
307
self.remove()
175
308
if self.group is None:
176
309
self.group = dbus.Interface(
177
310
self.bus.get_object(avahi.DBUS_NAME,
178
311
self.server.EntryGroupNew()),
179
312
avahi.DBUS_INTERFACE_ENTRY_GROUP)
180
self.group.connect_to_signal('StateChanged',
181
self
182
.entry_group_state_changed)
183
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
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' ...",
184
317
self.name, self.type)
185
318
self.group.AddService(
186
319
self.interface,
191
324
dbus.UInt16(self.port),
192
325
avahi.string_array_to_txt_array(self.TXT))
193
326
self.group.Commit()
327
194
328
def entry_group_state_changed(self, state, error):
195
329
"""Derived from the Avahi example code"""
196
logger.debug(u"Avahi entry group state change: %i", state)
330
logger.debug("Avahi entry group state change: %i", state)
197
331
198
332
if state == avahi.ENTRY_GROUP_ESTABLISHED:
199
logger.debug(u"Zeroconf service established.")
333
logger.debug("Zeroconf service established.")
200
334
elif state == avahi.ENTRY_GROUP_COLLISION:
201
logger.warning(u"Zeroconf service name collision.")
335
logger.info("Zeroconf service name collision.")
202
336
self.rename()
203
337
elif state == avahi.ENTRY_GROUP_FAILURE:
204
logger.critical(u"Avahi: Error in group state changed %s",
338
logger.critical("Avahi: Error in group state changed %s",
205
339
unicode(error))
206
raise AvahiGroupError(u"State changed: %s"
207
% unicode(error))
340
raise AvahiGroupError("State changed: {0!s}"
341
.format(error))
342
208
343
def cleanup(self):
209
344
"""Derived from the Avahi example code"""
210
345
if self.group is not None:
211
self.group.Free()
346
try:
347
self.group.Free()
348
except (dbus.exceptions.UnknownMethodException,
349
dbus.exceptions.DBusException):
350
pass
212
351
self.group = None
213
def server_state_changed(self, state):
352
self.remove()
353
354
def server_state_changed(self, state, error=None):
214
355
"""Derived from the Avahi example code"""
215
logger.debug(u"Avahi server state change: %i", state)
216
if state == avahi.SERVER_COLLISION:
217
logger.error(u"Zeroconf server name collision")
218
self.remove()
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()
219
371
elif state == avahi.SERVER_RUNNING:
220
372
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
221
379
def activate(self):
222
380
"""Derived from the Avahi example code"""
223
381
if self.server is None:
224
382
self.server = dbus.Interface(
225
383
self.bus.get_object(avahi.DBUS_NAME,
226
avahi.DBUS_PATH_SERVER),
384
avahi.DBUS_PATH_SERVER,
385
follow_name_owner_changes=True),
227
386
avahi.DBUS_INTERFACE_SERVER)
228
self.server.connect_to_signal(u"StateChanged",
387
self.server.connect_to_signal("StateChanged",
229
388
self.server_state_changed)
230
389
self.server_state_changed(self.server.GetState())
231
390
232
391
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
233
410
class Client(object):
234
411
"""A representation of a client host served by this server.
235
412
236
413
Attributes:
237
name: string; from the config file, used in log messages and
238
D-Bus identifiers
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
417
checker: subprocess.Popen(); a running checker process used
418
to see if the client lives.
419
'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
423
runtime with vars(self) as dict, so that for
424
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
current_checker_command: string; current running checker_command
430
disable_initiator_tag: a gobject event source tag, or None
431
enabled: bool()
239
432
fingerprint: string (40 or 32 hexadecimal digits); used to
240
433
uniquely identify the client
241
secret: bytestring; sent verbatim (over TLS) to client
242
434
host: string; available for use by the checker command
243
created: datetime.datetime(); (UTC) object creation
244
last_enabled: datetime.datetime(); (UTC)
245
enabled: bool()
435
interval: datetime.timedelta(); How often to start a new checker
436
last_approval_request: datetime.datetime(); (UTC) or None
246
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
247
445
timeout: datetime.timedelta(); How long from last_checked_ok
248
446
until this client is disabled
249
interval: datetime.timedelta(); How often to start a new checker
250
disable_hook: If set, called by disable() as disable_hook(self)
251
checker: subprocess.Popen(); a running checker process used
252
to see if the client lives.
253
'None' if no process is running.
254
checker_initiator_tag: a gobject event source tag, or None
255
disable_initiator_tag: - '' -
256
checker_callback_tag: - '' -
257
checker_command: string; External command which is run to check if
258
client lives. %() expansions are done at
259
runtime with vars(self) as dict, so that for
260
instance %(name)s can be used in the command.
261
current_checker_command: string; current running checker_command
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()
262
452
"""
263
453
264
@staticmethod
265
def _timedelta_to_milliseconds(td):
266
"Convert a datetime.timedelta() to milliseconds"
267
return ((td.days * 24 * 60 * 60 * 1000)
268
+ (td.seconds * 1000)
269
+ (td.microseconds // 1000))
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
}
270
469
271
470
def timeout_milliseconds(self):
272
471
"Return the 'timeout' attribute in milliseconds"
273
return self._timedelta_to_milliseconds(self.timeout)
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)
274
477
275
478
def interval_milliseconds(self):
276
479
"Return the 'interval' attribute in milliseconds"
277
return self._timedelta_to_milliseconds(self.interval)
278
279
def __init__(self, name = None, disable_hook=None, config=None):
280
"""Note: the 'checker' key in 'config' sets the
281
'checker_command' attribute and *not* the 'checker'
282
attribute."""
480
return timedelta_to_milliseconds(self.interval)
481
482
def approval_delay_milliseconds(self):
483
return timedelta_to_milliseconds(self.approval_delay)
484
485
@staticmethod
486
def config_parser(config):
487
"""Construct a new dict of client settings of this form:
488
{ client_name: {setting_name: value, ...}, ...}
489
with exceptions for any special settings as defined above.
490
NOTE: Must be a pure function. Must return the same result
491
value given the same arguments.
492
"""
493
settings = {}
494
for client_name in config.sections():
495
section = dict(config.items(client_name))
496
client = settings[client_name] = {}
497
498
client["host"] = section["host"]
499
# Reformat values from string types to Python types
500
client["approved_by_default"] = config.getboolean(
501
client_name, "approved_by_default")
502
client["enabled"] = config.getboolean(client_name,
503
"enabled")
504
505
client["fingerprint"] = (section["fingerprint"].upper()
506
.replace(" ", ""))
507
if "secret" in section:
508
client["secret"] = section["secret"].decode("base64")
509
elif "secfile" in section:
510
with open(os.path.expanduser(os.path.expandvars
511
(section["secfile"])),
512
"rb") as secfile:
513
client["secret"] = secfile.read()
514
else:
515
raise TypeError("No secret or secfile for section {0}"
516
.format(section))
517
client["timeout"] = string_to_delta(section["timeout"])
518
client["extended_timeout"] = string_to_delta(
519
section["extended_timeout"])
520
client["interval"] = string_to_delta(section["interval"])
521
client["approval_delay"] = string_to_delta(
522
section["approval_delay"])
523
client["approval_duration"] = string_to_delta(
524
section["approval_duration"])
525
client["checker_command"] = section["checker"]
526
client["last_approval_request"] = None
527
client["last_checked_ok"] = None
528
client["last_checker_status"] = -2
529
530
return settings
531
532
def __init__(self, settings, name = None, server_settings=None):
283
533
self.name = name
284
if config is None:
285
config = {}
286
logger.debug(u"Creating client %r", self.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)
287
552
# Uppercase and remove spaces from fingerprint for later
288
553
# comparison purposes with return value from the fingerprint()
289
554
# function
290
self.fingerprint = (config[u"fingerprint"].upper()
291
.replace(u" ", u""))
292
logger.debug(u" Fingerprint: %s", self.fingerprint)
293
if u"secret" in config:
294
self.secret = config[u"secret"].decode(u"base64")
295
elif u"secfile" in config:
296
with open(os.path.expanduser(os.path.expandvars
297
(config[u"secfile"])),
298
"rb") as secfile:
299
self.secret = secfile.read()
300
else:
301
raise TypeError(u"No secret or secfile for client %s"
302
% self.name)
303
self.host = config.get(u"host", u"")
304
self.created = datetime.datetime.utcnow()
305
self.enabled = False
306
self.last_enabled = None
307
self.last_checked_ok = None
308
self.timeout = string_to_delta(config[u"timeout"])
309
self.interval = string_to_delta(config[u"interval"])
310
self.disable_hook = disable_hook
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
311
560
self.checker = None
312
561
self.checker_initiator_tag = None
313
562
self.disable_initiator_tag = None
314
563
self.checker_callback_tag = None
315
self.checker_command = config[u"checker"]
316
564
self.current_checker_command = None
317
self.last_connect = None
565
self.approved = None
566
self.approvals_pending = 0
567
self.changedstate = (multiprocessing_manager
568
.Condition(multiprocessing_manager
569
.Lock()))
570
self.client_structure = [attr for attr in
571
self.__dict__.iterkeys()
572
if not attr.startswith("_")]
573
self.client_structure.append("client_structure")
574
575
for name, t in inspect.getmembers(type(self),
576
lambda obj:
577
isinstance(obj,
578
property)):
579
if not name.startswith("_"):
580
self.client_structure.append(name)
581
582
# Send notice to process children that client state has changed
583
def send_changedstate(self):
584
with self.changedstate:
585
self.changedstate.notify_all()
318
586
319
587
def enable(self):
320
588
"""Start this client's checker and timeout hooks"""
321
if getattr(self, u"enabled", False):
589
if getattr(self, "enabled", False):
322
590
# Already enabled
323
591
return
592
self.expires = datetime.datetime.utcnow() + self.timeout
593
self.enabled = True
324
594
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):
325
622
# Schedule a new checker to be started an 'interval' from now,
326
623
# and every interval from then on.
624
if self.checker_initiator_tag is not None:
625
gobject.source_remove(self.checker_initiator_tag)
327
626
self.checker_initiator_tag = (gobject.timeout_add
328
627
(self.interval_milliseconds(),
329
628
self.start_checker))
330
629
# Schedule a disable() when 'timeout' has passed
630
if self.disable_initiator_tag is not None:
631
gobject.source_remove(self.disable_initiator_tag)
331
632
self.disable_initiator_tag = (gobject.timeout_add
332
633
(self.timeout_milliseconds(),
333
634
self.disable))
334
self.enabled = True
335
635
# Also start a new checker *right now*.
336
636
self.start_checker()
337
637
338
def disable(self, quiet=True):
339
"""Disable this client."""
340
if not getattr(self, "enabled", False):
341
return False
342
if not quiet:
343
logger.info(u"Disabling client %s", self.name)
344
if getattr(self, u"disable_initiator_tag", False):
345
gobject.source_remove(self.disable_initiator_tag)
346
self.disable_initiator_tag = None
347
if getattr(self, u"checker_initiator_tag", False):
348
gobject.source_remove(self.checker_initiator_tag)
349
self.checker_initiator_tag = None
350
self.stop_checker()
351
if self.disable_hook:
352
self.disable_hook(self)
353
self.enabled = False
354
# Do not run this again if called by a gobject.timeout_add
355
return False
356
357
def __del__(self):
358
self.disable_hook = None
359
self.disable()
360
361
638
def checker_callback(self, pid, condition, command):
362
639
"""The checker has completed, so take appropriate actions."""
363
640
self.checker_callback_tag = None
364
641
self.checker = None
365
642
if os.WIFEXITED(condition):
366
exitstatus = os.WEXITSTATUS(condition)
367
if exitstatus == 0:
368
logger.info(u"Checker for %(name)s succeeded",
643
self.last_checker_status = os.WEXITSTATUS(condition)
644
if self.last_checker_status == 0:
645
logger.info("Checker for %(name)s succeeded",
369
646
vars(self))
370
647
self.checked_ok()
371
648
else:
372
logger.info(u"Checker for %(name)s failed",
649
logger.info("Checker for %(name)s failed",
373
650
vars(self))
374
651
else:
375
logger.warning(u"Checker for %(name)s crashed?",
652
self.last_checker_status = -1
653
logger.warning("Checker for %(name)s crashed?",
376
654
vars(self))
377
655
378
656
def checked_ok(self):
379
"""Bump up the timeout for this client.
380
381
This should only be called when the client has been seen,
382
alive and well.
383
"""
657
"""Assert that the client has been seen, alive and well."""
384
658
self.last_checked_ok = datetime.datetime.utcnow()
385
gobject.source_remove(self.disable_initiator_tag)
386
self.disable_initiator_tag = (gobject.timeout_add
387
(self.timeout_milliseconds(),
388
self.disable))
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()
389
677
390
678
def start_checker(self):
391
679
"""Start a new checker subprocess if one is not running.
393
681
If a checker already exists, leave it running and do
394
682
nothing."""
395
683
# The reason for not killing a running checker is that if we
396
# did that, then if a checker (for some reason) started
397
# running slowly and taking more than 'interval' time, the
398
# client would inevitably timeout, since no checker would get
399
# a chance to run to completion. If we instead leave running
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
400
688
# checkers alone, the checker would have to take more time
401
689
# than 'timeout' for the client to be disabled, which is as it
402
690
# should be.
404
692
# If a checker exists, make sure it is not a zombie
405
693
try:
406
694
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
407
except (AttributeError, OSError), error:
408
if (isinstance(error, OSError)
409
and error.errno != errno.ECHILD):
410
raise error
695
except AttributeError:
696
pass
697
except OSError as error:
698
if error.errno != errno.ECHILD:
699
raise
411
700
else:
412
701
if pid:
413
logger.warning(u"Checker was a zombie")
702
logger.warning("Checker was a zombie")
414
703
gobject.source_remove(self.checker_callback_tag)
415
704
self.checker_callback(pid, status,
416
705
self.current_checker_command)
417
706
# Start a new checker if needed
418
707
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)
419
713
try:
420
# In case checker_command has exactly one % operator
421
command = self.checker_command % self.host
422
except TypeError:
423
# Escape attributes for the shell
424
escaped_attrs = dict((key,
425
re.escape(unicode(str(val),
426
errors=
427
u'replace')))
428
for key, val in
429
vars(self).iteritems())
430
try:
431
command = self.checker_command % escaped_attrs
432
except TypeError, error:
433
logger.error(u'Could not format string "%s":'
434
u' %s', self.checker_command, error)
435
return True # Try again later
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
436
719
self.current_checker_command = command
437
720
try:
438
logger.info(u"Starting checker %r for %s",
721
logger.info("Starting checker %r for %s",
439
722
command, self.name)
440
723
# We don't need to redirect stdout and stderr, since
441
724
# in normal mode, that is already done by daemon(),
442
725
# and in debug mode we don't want to. (Stdin is
443
726
# 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 })
444
735
self.checker = subprocess.Popen(command,
445
736
close_fds=True,
446
shell=True, cwd=u"/")
447
self.checker_callback_tag = (gobject.child_watch_add
448
(self.checker.pid,
449
self.checker_callback,
450
data=command))
451
# The checker may have completed before the gobject
452
# watch was added. Check for this.
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:
453
750
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
454
if pid:
455
gobject.source_remove(self.checker_callback_tag)
456
self.checker_callback(pid, status, command)
457
except OSError, error:
458
logger.error(u"Failed to start subprocess: %s",
459
error)
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)
460
761
# Re-run this periodically if run by gobject.timeout_add
461
762
return True
462
763
465
766
if self.checker_callback_tag:
466
767
gobject.source_remove(self.checker_callback_tag)
467
768
self.checker_callback_tag = None
468
if getattr(self, u"checker", None) is None:
769
if getattr(self, "checker", None) is None:
469
770
return
470
logger.debug(u"Stopping checker for %(name)s", vars(self))
771
logger.debug("Stopping checker for %(name)s", vars(self))
471
772
try:
472
os.kill(self.checker.pid, signal.SIGTERM)
773
self.checker.terminate()
473
774
#time.sleep(0.5)
474
775
#if self.checker.poll() is None:
475
# os.kill(self.checker.pid, signal.SIGKILL)
476
except OSError, error:
776
# self.checker.kill()
777
except OSError as error:
477
778
if error.errno != errno.ESRCH: # No such process
478
779
raise
479
780
self.checker = None
480
781
481
782
482
def dbus_service_property(dbus_interface, signature=u"v",
483
access=u"readwrite", byte_arrays=False):
783
def dbus_service_property(dbus_interface, signature="v",
784
access="readwrite", byte_arrays=False):
484
785
"""Decorators for marking methods of a DBusObjectWithProperties to
485
786
become properties on the D-Bus.
486
787
493
794
"""
494
795
# Encoding deeply encoded byte arrays is not supported yet by the
495
796
# "Set" method, so we fail early here:
496
if byte_arrays and signature != u"ay":
497
raise ValueError(u"Byte arrays not supported for non-'ay'"
498
u" signature %r" % signature)
797
if byte_arrays and signature != "ay":
798
raise ValueError("Byte arrays not supported for non-'ay'"
799
" signature {0!r}".format(signature))
499
800
def decorator(func):
500
801
func._dbus_is_property = True
501
802
func._dbus_interface = dbus_interface
502
803
func._dbus_signature = signature
503
804
func._dbus_access = access
504
805
func._dbus_name = func.__name__
505
if func._dbus_name.endswith(u"_dbus_property"):
806
if func._dbus_name.endswith("_dbus_property"):
506
807
func._dbus_name = func._dbus_name[:-14]
507
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
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
508
846
return func
509
847
return decorator
510
848
530
868
531
869
class DBusObjectWithProperties(dbus.service.Object):
532
870
"""A D-Bus object with properties.
533
871
534
872
Classes inheriting from this can use the dbus_service_property
535
873
decorator to expose methods as D-Bus properties. It exposes the
536
874
standard Get(), Set(), and GetAll() methods on the D-Bus.
537
875
"""
538
876
539
877
@staticmethod
540
def _is_dbus_property(obj):
541
return getattr(obj, u"_dbus_is_property", False)
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)
542
886
543
def _get_all_dbus_properties(self):
887
def _get_all_dbus_things(self, thing):
544
888
"""Returns a generator of (name, attribute) pairs
545
889
"""
546
return ((prop._dbus_name, prop)
547
for name, prop in
548
inspect.getmembers(self, self._is_dbus_property))
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)))
549
897
550
898
def _get_dbus_property(self, interface_name, property_name):
551
899
"""Returns a bound method if one exists which is a D-Bus
552
900
property with the specified name and interface.
553
901
"""
554
for name in (property_name,
555
property_name + u"_dbus_property"):
556
prop = getattr(self, name, None)
557
if (prop is None
558
or not self._is_dbus_property(prop)
559
or prop._dbus_name != property_name
560
or (interface_name and prop._dbus_interface
561
and interface_name != prop._dbus_interface)):
562
continue
563
return prop
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
564
910
# No such property
565
raise DBusPropertyNotFound(self.dbus_object_path + u":"
566
+ interface_name + u"."
911
raise DBusPropertyNotFound(self.dbus_object_path + ":"
912
+ interface_name + "."
567
913
+ property_name)
568
914
569
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
570
out_signature=u"v")
915
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
916
out_signature="v")
571
917
def Get(self, interface_name, property_name):
572
918
"""Standard D-Bus property Get() method, see D-Bus standard.
573
919
"""
574
920
prop = self._get_dbus_property(interface_name, property_name)
575
if prop._dbus_access == u"write":
921
if prop._dbus_access == "write":
576
922
raise DBusPropertyAccessException(property_name)
577
923
value = prop()
578
if not hasattr(value, u"variant_level"):
924
if not hasattr(value, "variant_level"):
579
925
return value
580
926
return type(value)(value, variant_level=value.variant_level+1)
581
927
582
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
928
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
583
929
def Set(self, interface_name, property_name, value):
584
930
"""Standard D-Bus property Set() method, see D-Bus standard.
585
931
"""
586
932
prop = self._get_dbus_property(interface_name, property_name)
587
if prop._dbus_access == u"read":
933
if prop._dbus_access == "read":
588
934
raise DBusPropertyAccessException(property_name)
589
if prop._dbus_get_args_options[u"byte_arrays"]:
935
if prop._dbus_get_args_options["byte_arrays"]:
590
936
# The byte_arrays option is not supported yet on
591
937
# signatures other than "ay".
592
if prop._dbus_signature != u"ay":
593
raise ValueError
594
value = dbus.ByteArray(''.join(unichr(byte)
595
for byte in value))
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))
596
944
prop(value)
597
945
598
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
599
out_signature=u"a{sv}")
946
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
947
out_signature="a{sv}")
600
948
def GetAll(self, interface_name):
601
949
"""Standard D-Bus property GetAll() method, see D-Bus
602
950
standard.
603
951
604
952
Note: Will not include properties with access="write".
605
953
"""
606
all = {}
607
for name, prop in self._get_all_dbus_properties():
954
properties = {}
955
for name, prop in self._get_all_dbus_things("property"):
608
956
if (interface_name
609
957
and interface_name != prop._dbus_interface):
610
958
# Interface non-empty but did not match
611
959
continue
612
960
# Ignore write-only properties
613
if prop._dbus_access == u"write":
961
if prop._dbus_access == "write":
614
962
continue
615
963
value = prop()
616
if not hasattr(value, u"variant_level"):
617
all[name] = value
964
if not hasattr(value, "variant_level"):
965
properties[name] = value
618
966
continue
619
all[name] = type(value)(value, variant_level=
620
value.variant_level+1)
621
return dbus.Dictionary(all, signature=u"sv")
967
properties[name] = type(value)(value, variant_level=
968
value.variant_level+1)
969
return dbus.Dictionary(properties, signature="sv")
622
970
623
971
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
624
out_signature=u"s",
972
out_signature="s",
625
973
path_keyword='object_path',
626
974
connection_keyword='connection')
627
975
def Introspect(self, object_path, connection):
628
"""Standard D-Bus method, overloaded to insert property tags.
976
"""Overloading of standard D-Bus method.
977
978
Inserts property tags and interface annotation tags.
629
979
"""
630
980
xmlstring = dbus.service.Object.Introspect(self, object_path,
631
981
connection)
632
982
try:
633
983
document = xml.dom.minidom.parseString(xmlstring)
634
984
def make_tag(document, name, prop):
635
e = document.createElement(u"property")
636
e.setAttribute(u"name", name)
637
e.setAttribute(u"type", prop._dbus_signature)
638
e.setAttribute(u"access", prop._dbus_access)
985
e = document.createElement("property")
986
e.setAttribute("name", name)
987
e.setAttribute("type", prop._dbus_signature)
988
e.setAttribute("access", prop._dbus_access)
639
989
return e
640
for if_tag in document.getElementsByTagName(u"interface"):
990
for if_tag in document.getElementsByTagName("interface"):
991
# Add property tags
641
992
for tag in (make_tag(document, name, prop)
642
993
for name, prop
643
in self._get_all_dbus_properties()
994
in self._get_all_dbus_things("property")
644
995
if prop._dbus_interface
645
== if_tag.getAttribute(u"name")):
996
== if_tag.getAttribute("name")):
646
997
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)
647
1029
# Add the names to the return values for the
648
1030
# "org.freedesktop.DBus.Properties" methods
649
if (if_tag.getAttribute(u"name")
650
== u"org.freedesktop.DBus.Properties"):
651
for cn in if_tag.getElementsByTagName(u"method"):
652
if cn.getAttribute(u"name") == u"Get":
653
for arg in cn.getElementsByTagName(u"arg"):
654
if (arg.getAttribute(u"direction")
655
== u"out"):
656
arg.setAttribute(u"name", u"value")
657
elif cn.getAttribute(u"name") == u"GetAll":
658
for arg in cn.getElementsByTagName(u"arg"):
659
if (arg.getAttribute(u"direction")
660
== u"out"):
661
arg.setAttribute(u"name", u"props")
662
xmlstring = document.toxml(u"utf-8")
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")
663
1045
document.unlink()
664
1046
except (AttributeError, xml.dom.DOMException,
665
xml.parsers.expat.ExpatError), error:
666
logger.error(u"Failed to override Introspection method",
667
error)
1047
xml.parsers.expat.ExpatError) as error:
1048
logger.error("Failed to override Introspection method",
1049
exc_info=error)
668
1050
return xmlstring
669
1051
670
1052
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"})
671
1232
class ClientDBus(Client, DBusObjectWithProperties):
672
1233
"""A Client class using D-Bus
673
1234
675
1236
dbus_object_path: dbus.ObjectPath
676
1237
bus: dbus.SystemBus()
677
1238
"""
1239
1240
runtime_expansions = (Client.runtime_expansions
1241
+ ("dbus_object_path",))
1242
678
1243
# dbus.service.Object doesn't use super(), so we can't either.
679
1244
680
1245
def __init__(self, bus = None, *args, **kwargs):
682
1247
Client.__init__(self, *args, **kwargs)
683
1248
# Only now, when this client is initialized, can it show up on
684
1249
# the D-Bus
1250
client_object_name = unicode(self.name).translate(
1251
{ord("."): ord("_"),
1252
ord("-"): ord("_")})
685
1253
self.dbus_object_path = (dbus.ObjectPath
686
(u"/clients/"
687
+ self.name.replace(u".", u"_")))
1254
("/clients/" + client_object_name))
688
1255
DBusObjectWithProperties.__init__(self, self.bus,
689
1256
self.dbus_object_path)
690
1257
691
@staticmethod
692
def _datetime_to_dbus(dt, variant_level=0):
693
"""Convert a UTC datetime.datetime() to a D-Bus type."""
694
return dbus.String(dt.isoformat(),
695
variant_level=variant_level)
696
697
def enable(self):
698
oldstate = getattr(self, u"enabled", False)
699
r = Client.enable(self)
700
if oldstate != self.enabled:
701
# Emit D-Bus signals
702
self.PropertyChanged(dbus.String(u"enabled"),
703
dbus.Boolean(True, variant_level=1))
704
self.PropertyChanged(
705
dbus.String(u"last_enabled"),
706
self._datetime_to_dbus(self.last_enabled,
707
variant_level=1))
708
return r
709
710
def disable(self, quiet = False):
711
oldstate = getattr(self, u"enabled", False)
712
r = Client.disable(self, quiet=quiet)
713
if not quiet and oldstate != self.enabled:
714
# Emit D-Bus signal
715
self.PropertyChanged(dbus.String(u"enabled"),
716
dbus.Boolean(False, variant_level=1))
717
return r
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
718
1325
719
1326
def __del__(self, *args, **kwargs):
720
1327
try:
721
1328
self.remove_from_connection()
722
1329
except LookupError:
723
1330
pass
724
if hasattr(DBusObjectWithProperties, u"__del__"):
1331
if hasattr(DBusObjectWithProperties, "__del__"):
725
1332
DBusObjectWithProperties.__del__(self, *args, **kwargs)
726
1333
Client.__del__(self, *args, **kwargs)
727
1334
729
1336
*args, **kwargs):
730
1337
self.checker_callback_tag = None
731
1338
self.checker = None
732
# Emit D-Bus signal
733
self.PropertyChanged(dbus.String(u"checker_running"),
734
dbus.Boolean(False, variant_level=1))
735
1339
if os.WIFEXITED(condition):
736
1340
exitstatus = os.WEXITSTATUS(condition)
737
1341
# Emit D-Bus signal
747
1351
return Client.checker_callback(self, pid, condition, command,
748
1352
*args, **kwargs)
749
1353
750
def checked_ok(self, *args, **kwargs):
751
r = Client.checked_ok(self, *args, **kwargs)
752
# Emit D-Bus signal
753
self.PropertyChanged(
754
dbus.String(u"last_checked_ok"),
755
(self._datetime_to_dbus(self.last_checked_ok,
756
variant_level=1)))
757
return r
758
759
1354
def start_checker(self, *args, **kwargs):
760
1355
old_checker = self.checker
761
1356
if self.checker is not None:
768
1363
and old_checker_pid != self.checker.pid):
769
1364
# Emit D-Bus signal
770
1365
self.CheckerStarted(self.current_checker_command)
771
self.PropertyChanged(
772
dbus.String(u"checker_running"),
773
dbus.Boolean(True, variant_level=1))
774
return r
775
776
def stop_checker(self, *args, **kwargs):
777
old_checker = getattr(self, u"checker", None)
778
r = Client.stop_checker(self, *args, **kwargs)
779
if (old_checker is not None
780
and getattr(self, u"checker", None) is None):
781
self.PropertyChanged(dbus.String(u"checker_running"),
782
dbus.Boolean(False, variant_level=1))
783
return r
1366
return r
1367
1368
def _reset_approved(self):
1369
self.approved = None
1370
return False
1371
1372
def approve(self, value=True):
1373
self.approved = value
1374
gobject.timeout_add(timedelta_to_milliseconds
1375
(self.approval_duration),
1376
self._reset_approved)
1377
self.send_changedstate()
784
1378
785
1379
## D-Bus methods, signals & properties
786
_interface = u"se.bsnet.fukt.Mandos.Client"
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"}
787
1388
788
1389
## Signals
789
1390
790
1391
# CheckerCompleted - signal
791
@dbus.service.signal(_interface, signature=u"nxs")
1392
@dbus.service.signal(_interface, signature="nxs")
792
1393
def CheckerCompleted(self, exitcode, waitstatus, command):
793
1394
"D-Bus signal"
794
1395
pass
795
1396
796
1397
# CheckerStarted - signal
797
@dbus.service.signal(_interface, signature=u"s")
1398
@dbus.service.signal(_interface, signature="s")
798
1399
def CheckerStarted(self, command):
799
1400
"D-Bus signal"
800
1401
pass
801
1402
802
1403
# PropertyChanged - signal
803
@dbus.service.signal(_interface, signature=u"sv")
1404
@dbus.service.signal(_interface, signature="sv")
804
1405
def PropertyChanged(self, property, value):
805
1406
"D-Bus signal"
806
1407
pass
808
1409
# GotSecret - signal
809
1410
@dbus.service.signal(_interface)
810
1411
def GotSecret(self):
811
"D-Bus signal"
1412
"""D-Bus signal
1413
Is sent after a successful transfer of secret from the Mandos
1414
server to mandos-client
1415
"""
812
1416
pass
813
1417
814
1418
# Rejected - signal
815
@dbus.service.signal(_interface)
816
def Rejected(self):
1419
@dbus.service.signal(_interface, signature="s")
1420
def Rejected(self, reason):
817
1421
"D-Bus signal"
818
1422
pass
819
1423
1424
# NeedApproval - signal
1425
@dbus.service.signal(_interface, signature="tb")
1426
def NeedApproval(self, timeout, default):
1427
"D-Bus signal"
1428
return self.need_approval()
1429
820
1430
## Methods
821
1431
1432
# Approve - method
1433
@dbus.service.method(_interface, in_signature="b")
1434
def Approve(self, value):
1435
self.approve(value)
1436
822
1437
# CheckedOK - method
823
1438
@dbus.service.method(_interface)
824
1439
def CheckedOK(self):
825
return self.checked_ok()
1440
self.checked_ok()
826
1441
827
1442
# Enable - method
828
1443
@dbus.service.method(_interface)
849
1464
850
1465
## Properties
851
1466
852
# name - property
853
@dbus_service_property(_interface, signature=u"s", access=u"read")
854
def name_dbus_property(self):
1467
# ApprovalPending - property
1468
@dbus_service_property(_interface, signature="b", access="read")
1469
def ApprovalPending_dbus_property(self):
1470
return dbus.Boolean(bool(self.approvals_pending))
1471
1472
# ApprovedByDefault - property
1473
@dbus_service_property(_interface, signature="b",
1474
access="readwrite")
1475
def ApprovedByDefault_dbus_property(self, value=None):
1476
if value is None: # get
1477
return dbus.Boolean(self.approved_by_default)
1478
self.approved_by_default = bool(value)
1479
1480
# ApprovalDelay - property
1481
@dbus_service_property(_interface, signature="t",
1482
access="readwrite")
1483
def ApprovalDelay_dbus_property(self, value=None):
1484
if value is None: # get
1485
return dbus.UInt64(self.approval_delay_milliseconds())
1486
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1487
1488
# ApprovalDuration - property
1489
@dbus_service_property(_interface, signature="t",
1490
access="readwrite")
1491
def ApprovalDuration_dbus_property(self, value=None):
1492
if value is None: # get
1493
return dbus.UInt64(timedelta_to_milliseconds(
1494
self.approval_duration))
1495
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1496
1497
# Name - property
1498
@dbus_service_property(_interface, signature="s", access="read")
1499
def Name_dbus_property(self):
855
1500
return dbus.String(self.name)
856
1501
857
# fingerprint - property
858
@dbus_service_property(_interface, signature=u"s", access=u"read")
859
def fingerprint_dbus_property(self):
1502
# Fingerprint - property
1503
@dbus_service_property(_interface, signature="s", access="read")
1504
def Fingerprint_dbus_property(self):
860
1505
return dbus.String(self.fingerprint)
861
1506
862
# host - property
863
@dbus_service_property(_interface, signature=u"s",
864
access=u"readwrite")
865
def host_dbus_property(self, value=None):
1507
# Host - property
1508
@dbus_service_property(_interface, signature="s",
1509
access="readwrite")
1510
def Host_dbus_property(self, value=None):
866
1511
if value is None: # get
867
1512
return dbus.String(self.host)
868
self.host = value
869
# Emit D-Bus signal
870
self.PropertyChanged(dbus.String(u"host"),
871
dbus.String(value, variant_level=1))
872
873
# created - property
874
@dbus_service_property(_interface, signature=u"s", access=u"read")
875
def created_dbus_property(self):
876
return dbus.String(self._datetime_to_dbus(self.created))
877
878
# last_enabled - property
879
@dbus_service_property(_interface, signature=u"s", access=u"read")
880
def last_enabled_dbus_property(self):
881
if self.last_enabled is None:
882
return dbus.String(u"")
883
return dbus.String(self._datetime_to_dbus(self.last_enabled))
884
885
# enabled - property
886
@dbus_service_property(_interface, signature=u"b",
887
access=u"readwrite")
888
def enabled_dbus_property(self, value=None):
1513
self.host = unicode(value)
1514
1515
# Created - property
1516
@dbus_service_property(_interface, signature="s", access="read")
1517
def Created_dbus_property(self):
1518
return datetime_to_dbus(self.created)
1519
1520
# LastEnabled - property
1521
@dbus_service_property(_interface, signature="s", access="read")
1522
def LastEnabled_dbus_property(self):
1523
return datetime_to_dbus(self.last_enabled)
1524
1525
# Enabled - property
1526
@dbus_service_property(_interface, signature="b",
1527
access="readwrite")
1528
def Enabled_dbus_property(self, value=None):
889
1529
if value is None: # get
890
1530
return dbus.Boolean(self.enabled)
891
1531
if value:
893
1533
else:
894
1534
self.disable()
895
1535
896
# last_checked_ok - property
897
@dbus_service_property(_interface, signature=u"s",
898
access=u"readwrite")
899
def last_checked_ok_dbus_property(self, value=None):
1536
# LastCheckedOK - property
1537
@dbus_service_property(_interface, signature="s",
1538
access="readwrite")
1539
def LastCheckedOK_dbus_property(self, value=None):
900
1540
if value is not None:
901
1541
self.checked_ok()
902
1542
return
903
if self.last_checked_ok is None:
904
return dbus.String(u"")
905
return dbus.String(self._datetime_to_dbus(self
906
.last_checked_ok))
907
908
# timeout - property
909
@dbus_service_property(_interface, signature=u"t",
910
access=u"readwrite")
911
def timeout_dbus_property(self, value=None):
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)
1560
1561
# Timeout - property
1562
@dbus_service_property(_interface, signature="t",
1563
access="readwrite")
1564
def Timeout_dbus_property(self, value=None):
912
1565
if value is None: # get
913
1566
return dbus.UInt64(self.timeout_milliseconds())
1567
old_timeout = self.timeout
914
1568
self.timeout = datetime.timedelta(0, 0, 0, value)
915
# Emit D-Bus signal
916
self.PropertyChanged(dbus.String(u"timeout"),
917
dbus.UInt64(value, variant_level=1))
918
if getattr(self, u"disable_initiator_tag", None) is None:
919
return
920
# Reschedule timeout
921
gobject.source_remove(self.disable_initiator_tag)
922
self.disable_initiator_tag = None
923
time_to_die = (self.
924
_timedelta_to_milliseconds((self
925
.last_checked_ok
926
+ self.timeout)
927
- datetime.datetime
928
.utcnow()))
929
if time_to_die <= 0:
930
# The timeout has passed
931
self.disable()
932
else:
933
self.disable_initiator_tag = (gobject.timeout_add
934
(time_to_die, self.disable))
935
936
# interval - property
937
@dbus_service_property(_interface, signature=u"t",
938
access=u"readwrite")
939
def interval_dbus_property(self, value=None):
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)
1593
1594
# Interval - property
1595
@dbus_service_property(_interface, signature="t",
1596
access="readwrite")
1597
def Interval_dbus_property(self, value=None):
940
1598
if value is None: # get
941
1599
return dbus.UInt64(self.interval_milliseconds())
942
1600
self.interval = datetime.timedelta(0, 0, 0, value)
943
# Emit D-Bus signal
944
self.PropertyChanged(dbus.String(u"interval"),
945
dbus.UInt64(value, variant_level=1))
946
if getattr(self, u"checker_initiator_tag", None) is None:
1601
if getattr(self, "checker_initiator_tag", None) is None:
947
1602
return
948
# Reschedule checker run
949
gobject.source_remove(self.checker_initiator_tag)
950
self.checker_initiator_tag = (gobject.timeout_add
951
(value, self.start_checker))
952
self.start_checker() # Start one now, too
953
954
# checker - property
955
@dbus_service_property(_interface, signature=u"s",
956
access=u"readwrite")
957
def checker_dbus_property(self, value=None):
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
1610
# Checker - property
1611
@dbus_service_property(_interface, signature="s",
1612
access="readwrite")
1613
def Checker_dbus_property(self, value=None):
958
1614
if value is None: # get
959
1615
return dbus.String(self.checker_command)
960
self.checker_command = value
961
# Emit D-Bus signal
962
self.PropertyChanged(dbus.String(u"checker"),
963
dbus.String(self.checker_command,
964
variant_level=1))
1616
self.checker_command = unicode(value)
965
1617
966
# checker_running - property
967
@dbus_service_property(_interface, signature=u"b",
968
access=u"readwrite")
969
def checker_running_dbus_property(self, value=None):
1618
# CheckerRunning - property
1619
@dbus_service_property(_interface, signature="b",
1620
access="readwrite")
1621
def CheckerRunning_dbus_property(self, value=None):
970
1622
if value is None: # get
971
1623
return dbus.Boolean(self.checker is not None)
972
1624
if value:
974
1626
else:
975
1627
self.stop_checker()
976
1628
977
# object_path - property
978
@dbus_service_property(_interface, signature=u"o", access=u"read")
979
def object_path_dbus_property(self):
1629
# ObjectPath - property
1630
@dbus_service_property(_interface, signature="o", access="read")
1631
def ObjectPath_dbus_property(self):
980
1632
return self.dbus_object_path # is already a dbus.ObjectPath
981
1633
982
# secret = property
983
@dbus_service_property(_interface, signature=u"ay",
984
access=u"write", byte_arrays=True)
985
def secret_dbus_property(self, value):
1634
# Secret = property
1635
@dbus_service_property(_interface, signature="ay",
1636
access="write", byte_arrays=True)
1637
def Secret_dbus_property(self, value):
986
1638
self.secret = str(value)
987
1639
988
1640
del _interface
989
1641
990
1642
1643
class ProxyClient(object):
1644
def __init__(self, child_pipe, fpr, address):
1645
self._pipe = child_pipe
1646
self._pipe.send(('init', fpr, address))
1647
if not self._pipe.recv():
1648
raise KeyError()
1649
1650
def __getattribute__(self, name):
1651
if name == '_pipe':
1652
return super(ProxyClient, self).__getattribute__(name)
1653
self._pipe.send(('getattr', name))
1654
data = self._pipe.recv()
1655
if data[0] == 'data':
1656
return data[1]
1657
if data[0] == 'function':
1658
def func(*args, **kwargs):
1659
self._pipe.send(('funcall', name, args, kwargs))
1660
return self._pipe.recv()[1]
1661
return func
1662
1663
def __setattr__(self, name, value):
1664
if name == '_pipe':
1665
return super(ProxyClient, self).__setattr__(name, value)
1666
self._pipe.send(('setattr', name, value))
1667
1668
991
1669
class ClientHandler(socketserver.BaseRequestHandler, object):
992
1670
"""A class to handle client connections.
993
1671
995
1673
Note: This will run in its own forked process."""
996
1674
997
1675
def handle(self):
998
logger.info(u"TCP connection from: %s",
999
unicode(self.client_address))
1000
logger.debug(u"IPC Pipe FD: %d",
1001
self.server.child_pipe[1].fileno())
1002
# Open IPC pipe to parent process
1003
with contextlib.nested(self.server.child_pipe[1],
1004
self.server.parent_pipe[0]
1005
) as (ipc, ipc_return):
1676
with contextlib.closing(self.server.child_pipe) as child_pipe:
1677
logger.info("TCP connection from: %s",
1678
unicode(self.client_address))
1679
logger.debug("Pipe FD: %d",
1680
self.server.child_pipe.fileno())
1681
1006
1682
session = (gnutls.connection
1007
1683
.ClientSession(self.request,
1008
1684
gnutls.connection
1013
1689
# no X.509 keys are added to it. Therefore, we can use it
1014
1690
# here despite using OpenPGP certificates.
1015
1691
1016
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1017
# u"+AES-256-CBC", u"+SHA1",
1018
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1019
# u"+DHE-DSS"))
1692
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1693
# "+AES-256-CBC", "+SHA1",
1694
# "+COMP-NULL", "+CTYPE-OPENPGP",
1695
# "+DHE-DSS"))
1020
1696
# Use a fallback default, since this MUST be set.
1021
1697
priority = self.server.gnutls_priority
1022
1698
if priority is None:
1023
priority = u"NORMAL"
1699
priority = "NORMAL"
1024
1700
(gnutls.library.functions
1025
1701
.gnutls_priority_set_direct(session._c_object,
1026
1702
priority, None))
1028
1704
# Start communication using the Mandos protocol
1029
1705
# Get protocol number
1030
1706
line = self.request.makefile().readline()
1031
logger.debug(u"Protocol version: %r", line)
1707
logger.debug("Protocol version: %r", line)
1032
1708
try:
1033
1709
if int(line.strip().split()[0]) > 1:
1034
raise RuntimeError
1035
except (ValueError, IndexError, RuntimeError), error:
1036
logger.error(u"Unknown protocol version: %s", error)
1710
raise RuntimeError(line)
1711
except (ValueError, IndexError, RuntimeError) as error:
1712
logger.error("Unknown protocol version: %s", error)
1037
1713
return
1038
1714
1039
1715
# Start GnuTLS connection
1040
1716
try:
1041
1717
session.handshake()
1042
except gnutls.errors.GNUTLSError, error:
1043
logger.warning(u"Handshake failed: %s", error)
1718
except gnutls.errors.GNUTLSError as error:
1719
logger.warning("Handshake failed: %s", error)
1044
1720
# Do not run session.bye() here: the session is not
1045
1721
# established. Just abandon the request.
1046
1722
return
1047
logger.debug(u"Handshake succeeded")
1723
logger.debug("Handshake succeeded")
1724
1725
approval_required = False
1048
1726
try:
1049
1727
try:
1050
1728
fpr = self.fingerprint(self.peer_certificate
1051
1729
(session))
1052
except (TypeError, gnutls.errors.GNUTLSError), error:
1053
logger.warning(u"Bad certificate: %s", error)
1054
return
1055
logger.debug(u"Fingerprint: %s", fpr)
1056
1057
for c in self.server.clients:
1058
if c.fingerprint == fpr:
1059
client = c
1730
except (TypeError,
1731
gnutls.errors.GNUTLSError) as error:
1732
logger.warning("Bad certificate: %s", error)
1733
return
1734
logger.debug("Fingerprint: %s", fpr)
1735
1736
try:
1737
client = ProxyClient(child_pipe, fpr,
1738
self.client_address)
1739
except KeyError:
1740
return
1741
1742
if client.approval_delay:
1743
delay = client.approval_delay
1744
client.approvals_pending += 1
1745
approval_required = True
1746
1747
while True:
1748
if not client.enabled:
1749
logger.info("Client %s is disabled",
1750
client.name)
1751
if self.server.use_dbus:
1752
# Emit D-Bus signal
1753
client.Rejected("Disabled")
1754
return
1755
1756
if client.approved or not client.approval_delay:
1757
#We are approved or approval is disabled
1060
1758
break
1061
else:
1062
ipc.write(u"NOTFOUND %s %s\n"
1063
% (fpr, unicode(self.client_address)))
1064
return
1065
1066
class ClientProxy(object):
1067
"""Client proxy object. Not for calling methods."""
1068
def __init__(self, client):
1069
self.client = client
1070
def __getattr__(self, name):
1071
if name.startswith("ipc_"):
1072
def tempfunc():
1073
ipc.write("%s %s\n" % (name[4:].upper(),
1074
self.client.name))
1075
return tempfunc
1076
if not hasattr(self.client, name):
1077
raise AttributeError
1078
ipc.write(u"GETATTR %s %s\n"
1079
% (name, self.client.fingerprint))
1080
return pickle.load(ipc_return)
1081
clientproxy = ClientProxy(client)
1082
# Have to check if client.enabled, since it is
1083
# possible that the client was disabled since the
1084
# GnuTLS session was established.
1085
if not clientproxy.enabled:
1086
clientproxy.ipc_disabled()
1087
return
1088
1089
clientproxy.ipc_sending()
1759
elif client.approved is None:
1760
logger.info("Client %s needs approval",
1761
client.name)
1762
if self.server.use_dbus:
1763
# Emit D-Bus signal
1764
client.NeedApproval(
1765
client.approval_delay_milliseconds(),
1766
client.approved_by_default)
1767
else:
1768
logger.warning("Client %s was not approved",
1769
client.name)
1770
if self.server.use_dbus:
1771
# Emit D-Bus signal
1772
client.Rejected("Denied")
1773
return
1774
1775
#wait until timeout or approved
1776
time = datetime.datetime.now()
1777
client.changedstate.acquire()
1778
client.changedstate.wait(
1779
float(timedelta_to_milliseconds(delay)
1780
/ 1000))
1781
client.changedstate.release()
1782
time2 = datetime.datetime.now()
1783
if (time2 - time) >= delay:
1784
if not client.approved_by_default:
1785
logger.warning("Client %s timed out while"
1786
" waiting for approval",
1787
client.name)
1788
if self.server.use_dbus:
1789
# Emit D-Bus signal
1790
client.Rejected("Approval timed out")
1791
return
1792
else:
1793
break
1794
else:
1795
delay -= time2 - time
1796
1090
1797
sent_size = 0
1091
1798
while sent_size < len(client.secret):
1092
sent = session.send(client.secret[sent_size:])
1093
logger.debug(u"Sent: %d, remaining: %d",
1799
try:
1800
sent = session.send(client.secret[sent_size:])
1801
except gnutls.errors.GNUTLSError as error:
1802
logger.warning("gnutls send failed",
1803
exc_info=error)
1804
return
1805
logger.debug("Sent: %d, remaining: %d",
1094
1806
sent, len(client.secret)
1095
1807
- (sent_size + sent))
1096
1808
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)
1813
if self.server.use_dbus:
1814
# Emit D-Bus signal
1815
client.GotSecret()
1816
1097
1817
finally:
1098
session.bye()
1818
if approval_required:
1819
client.approvals_pending -= 1
1820
try:
1821
session.bye()
1822
except gnutls.errors.GNUTLSError as error:
1823
logger.warning("GnuTLS bye failed",
1824
exc_info=error)
1099
1825
1100
1826
@staticmethod
1101
1827
def peer_certificate(session):
1111
1837
.gnutls_certificate_get_peers
1112
1838
(session._c_object, ctypes.byref(list_size)))
1113
1839
if not bool(cert_list) and list_size.value != 0:
1114
raise gnutls.errors.GNUTLSError(u"error getting peer"
1115
u" certificate")
1840
raise gnutls.errors.GNUTLSError("error getting peer"
1841
" certificate")
1116
1842
if list_size.value == 0:
1117
1843
return None
1118
1844
cert = cert_list[0]
1144
1870
if crtverify.value != 0:
1145
1871
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1146
1872
raise (gnutls.errors.CertificateSecurityError
1147
(u"Verify failed"))
1873
("Verify failed"))
1148
1874
# New buffer for the fingerprint
1149
1875
buf = ctypes.create_string_buffer(20)
1150
1876
buf_len = ctypes.c_size_t()
1157
1883
# Convert the buffer to a Python bytestring
1158
1884
fpr = ctypes.string_at(buf, buf_len.value)
1159
1885
# Convert the bytestring to hexadecimal notation
1160
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1886
hex_fpr = binascii.hexlify(fpr).upper()
1161
1887
return hex_fpr
1162
1888
1163
1889
1164
class ForkingMixInWithPipes(socketserver.ForkingMixIn, object):
1165
"""Like socketserver.ForkingMixIn, but also pass a pipe pair."""
1890
class MultiprocessingMixIn(object):
1891
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1892
def sub_process_main(self, request, address):
1893
try:
1894
self.finish_request(request, address)
1895
except Exception:
1896
self.handle_error(request, address)
1897
self.close_request(request)
1898
1899
def process_request(self, request, address):
1900
"""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
1906
1907
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1908
""" adds a pipe to the MixIn """
1166
1909
def process_request(self, request, client_address):
1167
1910
"""Overrides and wraps the original process_request().
1168
1911
1169
1912
This function creates a new pipe in self.pipe
1170
1913
"""
1171
# Child writes to child_pipe
1172
self.child_pipe = map(os.fdopen, os.pipe(), u"rw", (1, 0))
1173
# Parent writes to parent_pipe
1174
self.parent_pipe = map(os.fdopen, os.pipe(), u"rw", (1, 0))
1175
super(ForkingMixInWithPipes,
1176
self).process_request(request, client_address)
1177
# Close unused ends for parent
1178
self.parent_pipe[0].close() # close read end
1179
self.child_pipe[1].close() # close write end
1180
self.add_pipe_fds(self.child_pipe[0], self.parent_pipe[1])
1181
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
1914
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1915
1916
proc = MultiprocessingMixIn.process_request(self, request,
1917
client_address)
1918
self.child_pipe.close()
1919
self.add_pipe(parent_pipe, proc)
1920
1921
def add_pipe(self, parent_pipe, proc):
1182
1922
"""Dummy function; override as necessary"""
1183
child_pipe_fd.close()
1184
parent_pipe_fd.close()
1185
1186
1187
class IPv6_TCPServer(ForkingMixInWithPipes,
1923
raise NotImplementedError()
1924
1925
1926
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1188
1927
socketserver.TCPServer, object):
1189
1928
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1190
1929
1194
1933
use_ipv6: Boolean; to use IPv6 or not
1195
1934
"""
1196
1935
def __init__(self, server_address, RequestHandlerClass,
1197
interface=None, use_ipv6=True):
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
"""
1198
1940
self.interface = interface
1199
1941
if use_ipv6:
1200
1942
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.
1201
1969
socketserver.TCPServer.__init__(self, server_address,
1202
1970
RequestHandlerClass)
1971
1203
1972
def server_bind(self):
1204
1973
"""This overrides the normal server_bind() function
1205
1974
to bind to an interface if one was specified, and also NOT to
1206
1975
bind to an address or port if they were not specified."""
1207
1976
if self.interface is not None:
1208
1977
if SO_BINDTODEVICE is None:
1209
logger.error(u"SO_BINDTODEVICE does not exist;"
1210
u" cannot bind to interface %s",
1978
logger.error("SO_BINDTODEVICE does not exist;"
1979
" cannot bind to interface %s",
1211
1980
self.interface)
1212
1981
else:
1213
1982
try:
1214
1983
self.socket.setsockopt(socket.SOL_SOCKET,
1215
1984
SO_BINDTODEVICE,
1216
str(self.interface
1217
+ u'\0'))
1218
except socket.error, error:
1219
if error[0] == errno.EPERM:
1220
logger.error(u"No permission to"
1221
u" bind to interface %s",
1222
self.interface)
1223
elif error[0] == errno.ENOPROTOOPT:
1224
logger.error(u"SO_BINDTODEVICE not available;"
1225
u" cannot bind to interface %s",
1226
self.interface)
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)
1227
1997
else:
1228
1998
raise
1229
1999
# Only bind(2) the socket if we really need to.
1230
2000
if self.server_address[0] or self.server_address[1]:
1231
2001
if not self.server_address[0]:
1232
2002
if self.address_family == socket.AF_INET6:
1233
any_address = u"::" # in6addr_any
2003
any_address = "::" # in6addr_any
1234
2004
else:
1235
any_address = socket.INADDR_ANY
2005
any_address = "0.0.0.0" # INADDR_ANY
1236
2006
self.server_address = (any_address,
1237
2007
self.server_address[1])
1238
2008
elif not self.server_address[1]:
1259
2029
"""
1260
2030
def __init__(self, server_address, RequestHandlerClass,
1261
2031
interface=None, use_ipv6=True, clients=None,
1262
gnutls_priority=None, use_dbus=True):
2032
gnutls_priority=None, use_dbus=True, socketfd=None):
1263
2033
self.enabled = False
1264
2034
self.clients = clients
1265
2035
if self.clients is None:
1266
self.clients = set()
2036
self.clients = {}
1267
2037
self.use_dbus = use_dbus
1268
2038
self.gnutls_priority = gnutls_priority
1269
2039
IPv6_TCPServer.__init__(self, server_address,
1270
2040
RequestHandlerClass,
1271
2041
interface = interface,
1272
use_ipv6 = use_ipv6)
2042
use_ipv6 = use_ipv6,
2043
socketfd = socketfd)
1273
2044
def server_activate(self):
1274
2045
if self.enabled:
1275
2046
return socketserver.TCPServer.server_activate(self)
2047
1276
2048
def enable(self):
1277
2049
self.enabled = True
1278
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
2050
2051
def add_pipe(self, parent_pipe, proc):
1279
2052
# Call "handle_ipc" for both data and EOF events
1280
gobject.io_add_watch(child_pipe_fd.fileno(),
2053
gobject.io_add_watch(parent_pipe.fileno(),
1281
2054
gobject.IO_IN | gobject.IO_HUP,
1282
2055
functools.partial(self.handle_ipc,
1283
reply = parent_pipe_fd,
1284
sender= child_pipe_fd))
1285
def handle_ipc(self, source, condition, reply=None, sender=None):
1286
condition_names = {
1287
gobject.IO_IN: u"IN", # There is data to read.
1288
gobject.IO_OUT: u"OUT", # Data can be written (without
1289
# blocking).
1290
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1291
gobject.IO_ERR: u"ERR", # Error condition.
1292
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1293
# broken, usually for pipes and
1294
# sockets).
1295
}
1296
conditions_string = ' | '.join(name
1297
for cond, name in
1298
condition_names.iteritems()
1299
if cond & condition)
1300
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1301
conditions_string)
1302
1303
# Read a line from the file object
1304
cmdline = sender.readline()
1305
if not cmdline: # Empty line means end of file
1306
# close the IPC pipes
1307
sender.close()
1308
reply.close()
1309
1310
# Stop calling this function
1311
return False
1312
1313
logger.debug(u"IPC command: %r", cmdline)
1314
1315
# Parse and act on command
1316
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1317
1318
if cmd == u"NOTFOUND":
1319
fpr, address = args.split(None, 1)
1320
logger.warning(u"Client not found for fingerprint: %s, ad"
1321
u"dress: %s", fpr, address)
1322
if self.use_dbus:
1323
# Emit D-Bus signal
1324
mandos_dbus_service.ClientNotFound(fpr, address)
1325
elif cmd == u"DISABLED":
1326
for client in self.clients:
1327
if client.name == args:
1328
logger.warning(u"Client %s is disabled", args)
1329
if self.use_dbus:
1330
# Emit D-Bus signal
1331
client.Rejected()
1332
break
1333
else:
1334
logger.error(u"Unknown client %s is disabled", args)
1335
elif cmd == u"SENDING":
1336
for client in self.clients:
1337
if client.name == args:
1338
logger.info(u"Sending secret to %s", client.name)
1339
client.checked_ok()
1340
if self.use_dbus:
1341
# Emit D-Bus signal
1342
client.GotSecret()
1343
break
1344
else:
1345
logger.error(u"Sending secret to unknown client %s",
1346
args)
1347
elif cmd == u"GETATTR":
1348
attr_name, fpr = args.split(None, 1)
1349
for client in self.clients:
1350
if client.fingerprint == fpr:
1351
attr_value = getattr(client, attr_name, None)
1352
logger.debug("IPC reply: %r", attr_value)
1353
pickle.dump(attr_value, reply)
1354
break
1355
else:
1356
logger.error(u"Client %s on address %s requesting "
1357
u"attribute %s not found", fpr, address,
1358
attr_name)
1359
pickle.dump(None, reply)
2056
parent_pipe =
2057
parent_pipe,
2058
proc = proc))
2059
2060
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()
2066
return False
2067
2068
# Read a request from the child
2069
request = parent_pipe.recv()
2070
command = request[0]
2071
2072
if command == 'init':
2073
fpr = request[1]
2074
address = request[2]
2075
2076
for c in self.clients.itervalues():
2077
if c.fingerprint == fpr:
2078
client = c
2079
break
2080
else:
2081
logger.info("Client not found for fingerprint: %s, ad"
2082
"dress: %s", fpr, address)
2083
if self.use_dbus:
2084
# Emit D-Bus signal
2085
mandos_dbus_service.ClientNotFound(fpr,
2086
address[0])
2087
parent_pipe.send(False)
2088
return False
2089
2090
gobject.io_add_watch(parent_pipe.fileno(),
2091
gobject.IO_IN | gobject.IO_HUP,
2092
functools.partial(self.handle_ipc,
2093
parent_pipe =
2094
parent_pipe,
2095
proc = proc,
2096
client_object =
2097
client))
2098
parent_pipe.send(True)
2099
# remove the old hook in favor of the new above hook on
2100
# same fileno
2101
return False
2102
if command == 'funcall':
2103
funcname = request[1]
2104
args = request[2]
2105
kwargs = request[3]
2106
2107
parent_pipe.send(('data', getattr(client_object,
2108
funcname)(*args,
2109
**kwargs)))
2110
2111
if command == 'getattr':
2112
attrname = request[1]
2113
if callable(client_object.__getattribute__(attrname)):
2114
parent_pipe.send(('function',))
2115
else:
2116
parent_pipe.send(('data', client_object
2117
.__getattribute__(attrname)))
2118
2119
if command == 'setattr':
2120
attrname = request[1]
2121
value = request[2]
2122
setattr(client_object, attrname, value)
2123
2124
return True
2125
2126
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
1360
2219
else:
1361
logger.error(u"Unknown IPC command: %r", cmdline)
1362
1363
# Keep calling this function
1364
return True
2220
# No currently valid tokens were found
2221
raise ValueError("Invalid RFC 3339 duration")
2222
# End token found
2223
return value
1365
2224
1366
2225
1367
2226
def string_to_delta(interval):
1368
2227
"""Parse a string and return a datetime.timedelta
1369
2228
1370
>>> string_to_delta(u'7d')
2229
>>> string_to_delta('7d')
1371
2230
datetime.timedelta(7)
1372
>>> string_to_delta(u'60s')
2231
>>> string_to_delta('60s')
1373
2232
datetime.timedelta(0, 60)
1374
>>> string_to_delta(u'60m')
2233
>>> string_to_delta('60m')
1375
2234
datetime.timedelta(0, 3600)
1376
>>> string_to_delta(u'24h')
2235
>>> string_to_delta('24h')
1377
2236
datetime.timedelta(1)
1378
>>> string_to_delta(u'1w')
2237
>>> string_to_delta('1w')
1379
2238
datetime.timedelta(7)
1380
>>> string_to_delta(u'5m 30s')
2239
>>> string_to_delta('5m 30s')
1381
2240
datetime.timedelta(0, 330)
1382
2241
"""
2242
2243
try:
2244
return rfc3339_duration_to_delta(interval)
2245
except ValueError:
2246
pass
2247
1383
2248
timevalue = datetime.timedelta(0)
1384
2249
for s in interval.split():
1385
2250
try:
1386
2251
suffix = unicode(s[-1])
1387
2252
value = int(s[:-1])
1388
if suffix == u"d":
2253
if suffix == "d":
1389
2254
delta = datetime.timedelta(value)
1390
elif suffix == u"s":
2255
elif suffix == "s":
1391
2256
delta = datetime.timedelta(0, value)
1392
elif suffix == u"m":
2257
elif suffix == "m":
1393
2258
delta = datetime.timedelta(0, 0, 0, 0, value)
1394
elif suffix == u"h":
2259
elif suffix == "h":
1395
2260
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1396
elif suffix == u"w":
2261
elif suffix == "w":
1397
2262
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1398
2263
else:
1399
raise ValueError(u"Unknown suffix %r" % suffix)
1400
except (ValueError, IndexError), e:
1401
raise ValueError(e.message)
2264
raise ValueError("Unknown suffix {0!r}"
2265
.format(suffix))
2266
except IndexError as e:
2267
raise ValueError(*(e.args))
1402
2268
timevalue += delta
1403
2269
return timevalue
1404
2270
1405
2271
1406
def if_nametoindex(interface):
1407
"""Call the C function if_nametoindex(), or equivalent
1408
1409
Note: This function cannot accept a unicode string."""
1410
global if_nametoindex
1411
try:
1412
if_nametoindex = (ctypes.cdll.LoadLibrary
1413
(ctypes.util.find_library(u"c"))
1414
.if_nametoindex)
1415
except (OSError, AttributeError):
1416
logger.warning(u"Doing if_nametoindex the hard way")
1417
def if_nametoindex(interface):
1418
"Get an interface index the hard way, i.e. using fcntl()"
1419
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1420
with contextlib.closing(socket.socket()) as s:
1421
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1422
struct.pack(str(u"16s16x"),
1423
interface))
1424
interface_index = struct.unpack(str(u"I"),
1425
ifreq[16:20])[0]
1426
return interface_index
1427
return if_nametoindex(interface)
1428
1429
1430
2272
def daemon(nochdir = False, noclose = False):
1431
2273
"""See daemon(3). Standard BSD Unix function.
1432
2274
1435
2277
sys.exit()
1436
2278
os.setsid()
1437
2279
if not nochdir:
1438
os.chdir(u"/")
2280
os.chdir("/")
1439
2281
if os.fork():
1440
2282
sys.exit()
1441
2283
if not noclose:
1442
2284
# Close all standard open file descriptors
1443
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2285
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1444
2286
if not stat.S_ISCHR(os.fstat(null).st_mode):
1445
2287
raise OSError(errno.ENODEV,
1446
u"%s not a character device"
1447
% os.path.devnull)
2288
"{0} not a character device"
2289
.format(os.devnull))
1448
2290
os.dup2(null, sys.stdin.fileno())
1449
2291
os.dup2(null, sys.stdout.fileno())
1450
2292
os.dup2(null, sys.stderr.fileno())
1457
2299
##################################################################
1458
2300
# Parsing of options, both command line and config file
1459
2301
1460
parser = optparse.OptionParser(version = "%%prog %s" % version)
1461
parser.add_option("-i", u"--interface", type=u"string",
1462
metavar="IF", help=u"Bind to interface IF")
1463
parser.add_option("-a", u"--address", type=u"string",
1464
help=u"Address to listen for requests on")
1465
parser.add_option("-p", u"--port", type=u"int",
1466
help=u"Port number to receive requests on")
1467
parser.add_option("--check", action=u"store_true",
1468
help=u"Run self-test")
1469
parser.add_option("--debug", action=u"store_true",
1470
help=u"Debug mode; run in foreground and log to"
1471
u" terminal")
1472
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1473
u" priority string (see GnuTLS documentation)")
1474
parser.add_option("--servicename", type=u"string",
1475
metavar=u"NAME", help=u"Zeroconf service name")
1476
parser.add_option("--configdir", type=u"string",
1477
default=u"/etc/mandos", metavar=u"DIR",
1478
help=u"Directory to search for configuration"
1479
u" files")
1480
parser.add_option("--no-dbus", action=u"store_false",
1481
dest=u"use_dbus", help=u"Do not provide D-Bus"
1482
u" system bus interface")
1483
parser.add_option("--no-ipv6", action=u"store_false",
1484
dest=u"use_ipv6", help=u"Do not use IPv6")
1485
options = parser.parse_args()[0]
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()
1486
2345
1487
2346
if options.check:
1488
2347
import doctest
1489
doctest.testmod()
1490
sys.exit()
2348
fail_count, test_count = doctest.testmod()
2349
sys.exit(os.EX_OK if fail_count == 0 else 1)
1491
2350
1492
2351
# Default values for config file for server-global settings
1493
server_defaults = { u"interface": u"",
1494
u"address": u"",
1495
u"port": u"",
1496
u"debug": u"False",
1497
u"priority":
1498
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1499
u"servicename": u"Mandos",
1500
u"use_dbus": u"True",
1501
u"use_ipv6": u"True",
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",
1502
2366
}
1503
2367
1504
2368
# Parse config file for server-global settings
1505
2369
server_config = configparser.SafeConfigParser(server_defaults)
1506
2370
del server_defaults
1507
2371
server_config.read(os.path.join(options.configdir,
1508
u"mandos.conf"))
2372
"mandos.conf"))
1509
2373
# Convert the SafeConfigParser object to a dict
1510
2374
server_settings = server_config.defaults()
1511
2375
# Use the appropriate methods on the non-string config options
1512
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1513
server_settings[option] = server_config.getboolean(u"DEFAULT",
2376
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2377
server_settings[option] = server_config.getboolean("DEFAULT",
1514
2378
option)
1515
2379
if server_settings["port"]:
1516
server_settings["port"] = server_config.getint(u"DEFAULT",
1517
u"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"])
1518
2391
del server_config
1519
2392
1520
2393
# Override the settings from the config file with command line
1521
2394
# options, if set.
1522
for option in (u"interface", u"address", u"port", u"debug",
1523
u"priority", u"servicename", u"configdir",
1524
u"use_dbus", u"use_ipv6"):
2395
for option in ("interface", "address", "port", "debug",
2396
"priority", "servicename", "configdir",
2397
"use_dbus", "use_ipv6", "debuglevel", "restore",
2398
"statedir", "socket", "foreground"):
1525
2399
value = getattr(options, option)
1526
2400
if value is not None:
1527
2401
server_settings[option] = value
1530
2404
for option in server_settings.keys():
1531
2405
if type(server_settings[option]) is str:
1532
2406
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
1533
2414
# Now we have our good server settings in "server_settings"
1534
2415
1535
2416
##################################################################
1536
2417
1537
2418
# For convenience
1538
debug = server_settings[u"debug"]
1539
use_dbus = server_settings[u"use_dbus"]
1540
use_ipv6 = server_settings[u"use_ipv6"]
1541
1542
if not debug:
1543
syslogger.setLevel(logging.WARNING)
1544
console.setLevel(logging.WARNING)
1545
1546
if server_settings[u"servicename"] != u"Mandos":
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":
1547
2437
syslogger.setFormatter(logging.Formatter
1548
(u'Mandos (%s) [%%(process)d]:'
1549
u' %%(levelname)s: %%(message)s'
1550
% server_settings[u"servicename"]))
2438
('Mandos ({0}) [%(process)d]:'
2439
' %(levelname)s: %(message)s'
2440
.format(server_settings
2441
["servicename"])))
1551
2442
1552
2443
# Parse config file with clients
1553
client_defaults = { u"timeout": u"1h",
1554
u"interval": u"5m",
1555
u"checker": u"fping -q -- %%(host)s",
1556
u"host": u"",
1557
}
1558
client_config = configparser.SafeConfigParser(client_defaults)
1559
client_config.read(os.path.join(server_settings[u"configdir"],
1560
u"clients.conf"))
2444
client_config = configparser.SafeConfigParser(Client
2445
.client_defaults)
2446
client_config.read(os.path.join(server_settings["configdir"],
2447
"clients.conf"))
1561
2448
1562
2449
global mandos_dbus_service
1563
2450
mandos_dbus_service = None
1564
2451
1565
tcp_server = MandosServer((server_settings[u"address"],
1566
server_settings[u"port"]),
2452
tcp_server = MandosServer((server_settings["address"],
2453
server_settings["port"]),
1567
2454
ClientHandler,
1568
interface=(server_settings[u"interface"]
2455
interface=(server_settings["interface"]
1569
2456
or None),
1570
2457
use_ipv6=use_ipv6,
1571
2458
gnutls_priority=
1572
server_settings[u"priority"],
1573
use_dbus=use_dbus)
1574
pidfilename = u"/var/run/mandos.pid"
1575
try:
1576
pidfile = open(pidfilename, u"w")
1577
except IOError:
1578
logger.error(u"Could not open file %r", pidfilename)
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)
1579
2473
1580
try:
1581
uid = pwd.getpwnam(u"_mandos").pw_uid
1582
gid = pwd.getpwnam(u"_mandos").pw_gid
1583
except KeyError:
2474
for name in ("_mandos", "mandos", "nobody"):
1584
2475
try:
1585
uid = pwd.getpwnam(u"mandos").pw_uid
1586
gid = pwd.getpwnam(u"mandos").pw_gid
2476
uid = pwd.getpwnam(name).pw_uid
2477
gid = pwd.getpwnam(name).pw_gid
2478
break
1587
2479
except KeyError:
1588
try:
1589
uid = pwd.getpwnam(u"nobody").pw_uid
1590
gid = pwd.getpwnam(u"nobody").pw_gid
1591
except KeyError:
1592
uid = 65534
1593
gid = 65534
2480
continue
2481
else:
2482
uid = 65534
2483
gid = 65534
1594
2484
try:
1595
2485
os.setgid(gid)
1596
2486
os.setuid(uid)
1597
except OSError, error:
1598
if error[0] != errno.EPERM:
1599
raise error
2487
except OSError as error:
2488
if error.errno != errno.EPERM:
2489
raise
1600
2490
1601
# Enable all possible GnuTLS debugging
1602
2491
if debug:
2492
# Enable all possible GnuTLS debugging
2493
1603
2494
# "Use a log level over 10 to enable all debugging options."
1604
2495
# - GnuTLS manual
1605
2496
gnutls.library.functions.gnutls_global_set_log_level(11)
1606
2497
1607
2498
@gnutls.library.types.gnutls_log_func
1608
2499
def debug_gnutls(level, string):
1609
logger.debug(u"GnuTLS: %s", string[:-1])
2500
logger.debug("GnuTLS: %s", string[:-1])
1610
2501
1611
2502
(gnutls.library.functions
1612
2503
.gnutls_global_set_log_function(debug_gnutls))
2504
2505
# Redirect stdin so all checkers get /dev/null
2506
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2507
os.dup2(null, sys.stdin.fileno())
2508
if null > 2:
2509
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()
1613
2519
1614
2520
global main_loop
1615
2521
# From the Avahi example code
1616
DBusGMainLoop(set_as_default=True )
2522
DBusGMainLoop(set_as_default=True)
1617
2523
main_loop = gobject.MainLoop()
1618
2524
bus = dbus.SystemBus()
1619
2525
# End of Avahi example code
1620
2526
if use_dbus:
1621
2527
try:
1622
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2528
bus_name = dbus.service.BusName("se.recompile.Mandos",
1623
2529
bus, do_not_queue=True)
1624
except dbus.exceptions.NameExistsException, e:
1625
logger.error(unicode(e) + u", disabling D-Bus")
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)
1626
2535
use_dbus = False
1627
server_settings[u"use_dbus"] = False
2536
server_settings["use_dbus"] = False
1628
2537
tcp_server.use_dbus = False
1629
2538
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1630
service = AvahiService(name = server_settings[u"servicename"],
1631
servicetype = u"_mandos._tcp",
1632
protocol = protocol, bus = bus)
2539
service = AvahiServiceToSyslog(name =
2540
server_settings["servicename"],
2541
servicetype = "_mandos._tcp",
2542
protocol = protocol, bus = bus)
1633
2543
if server_settings["interface"]:
1634
2544
service.interface = (if_nametoindex
1635
(str(server_settings[u"interface"])))
2545
(str(server_settings["interface"])))
2546
2547
global multiprocessing_manager
2548
multiprocessing_manager = multiprocessing.Manager()
1636
2549
1637
2550
client_class = Client
1638
2551
if use_dbus:
1639
2552
client_class = functools.partial(ClientDBus, bus = bus)
1640
tcp_server.clients.update(set(
1641
client_class(name = section,
1642
config= dict(client_config.items(section)))
1643
for section in client_config.sections()))
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))
2635
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
1644
2661
if not tcp_server.clients:
1645
logger.warning(u"No clients defined")
1646
1647
if debug:
1648
# Redirect stdin so all checkers get /dev/null
1649
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1650
os.dup2(null, sys.stdin.fileno())
1651
if null > 2:
1652
os.close(null)
1653
else:
1654
# No console logging
1655
logger.removeHandler(console)
1656
# Close all input and output, do double fork, etc.
1657
daemon()
1658
1659
try:
1660
with pidfile:
1661
pid = os.getpid()
1662
pidfile.write(str(pid) + "\n")
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)
1663
2673
del pidfile
1664
except IOError:
1665
logger.error(u"Could not write to file %r with PID %d",
1666
pidfilename, pid)
1667
except NameError:
1668
# "pidfile" was never created
1669
pass
1670
del pidfilename
2674
del pidfilename
1671
2675
1672
if not debug:
1673
signal.signal(signal.SIGINT, signal.SIG_IGN)
1674
2676
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1675
2677
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1676
2678
1677
2679
if use_dbus:
1678
class MandosDBusService(dbus.service.Object):
2680
@alternate_dbus_interfaces({"se.recompile.Mandos":
2681
"se.bsnet.fukt.Mandos"})
2682
class MandosDBusService(DBusObjectWithProperties):
1679
2683
"""A D-Bus proxy object"""
1680
2684
def __init__(self):
1681
dbus.service.Object.__init__(self, bus, u"/")
1682
_interface = u"se.bsnet.fukt.Mandos"
1683
1684
@dbus.service.signal(_interface, signature=u"o")
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")
1685
2695
def ClientAdded(self, objpath):
1686
2696
"D-Bus signal"
1687
2697
pass
1688
2698
1689
@dbus.service.signal(_interface, signature=u"ss")
2699
@dbus.service.signal(_interface, signature="ss")
1690
2700
def ClientNotFound(self, fingerprint, address):
1691
2701
"D-Bus signal"
1692
2702
pass
1693
2703
1694
@dbus.service.signal(_interface, signature=u"os")
2704
@dbus.service.signal(_interface, signature="os")
1695
2705
def ClientRemoved(self, objpath, name):
1696
2706
"D-Bus signal"
1697
2707
pass
1698
2708
1699
@dbus.service.method(_interface, out_signature=u"ao")
2709
@dbus.service.method(_interface, out_signature="ao")
1700
2710
def GetAllClients(self):
1701
2711
"D-Bus method"
1702
2712
return dbus.Array(c.dbus_object_path
1703
for c in tcp_server.clients)
2713
for c in
2714
tcp_server.clients.itervalues())
1704
2715
1705
2716
@dbus.service.method(_interface,
1706
out_signature=u"a{oa{sv}}")
2717
out_signature="a{oa{sv}}")
1707
2718
def GetAllClientsWithProperties(self):
1708
2719
"D-Bus method"
1709
2720
return dbus.Dictionary(
1710
((c.dbus_object_path, c.GetAll(u""))
1711
for c in tcp_server.clients),
1712
signature=u"oa{sv}")
2721
((c.dbus_object_path, c.GetAll(""))
2722
for c in tcp_server.clients.itervalues()),
2723
signature="oa{sv}")
1713
2724
1714
@dbus.service.method(_interface, in_signature=u"o")
2725
@dbus.service.method(_interface, in_signature="o")
1715
2726
def RemoveClient(self, object_path):
1716
2727
"D-Bus method"
1717
for c in tcp_server.clients:
2728
for c in tcp_server.clients.itervalues():
1718
2729
if c.dbus_object_path == object_path:
1719
tcp_server.clients.remove(c)
2730
del tcp_server.clients[c.name]
1720
2731
c.remove_from_connection()
1721
2732
# Don't signal anything except ClientRemoved
1722
2733
c.disable(quiet=True)
1733
2744
"Cleanup function; run on exit"
1734
2745
service.cleanup()
1735
2746
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
1736
2803
while tcp_server.clients:
1737
client = tcp_server.clients.pop()
2804
name, client = tcp_server.clients.popitem()
1738
2805
if use_dbus:
1739
2806
client.remove_from_connection()
1740
client.disable_hook = None
1741
2807
# Don't signal anything except ClientRemoved
1742
2808
client.disable(quiet=True)
1743
2809
if use_dbus:
1744
2810
# Emit D-Bus signal
1745
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2811
mandos_dbus_service.ClientRemoved(client
2812
.dbus_object_path,
1746
2813
client.name)
2814
client_settings.clear()
1747
2815
1748
2816
atexit.register(cleanup)
1749
2817
1750
for client in tcp_server.clients:
2818
for client in tcp_server.clients.itervalues():
1751
2819
if use_dbus:
1752
2820
# Emit D-Bus signal
1753
2821
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1754
client.enable()
2822
# Need to initiate checking of clients
2823
if client.enabled:
2824
client.init_checker()
1755
2825
1756
2826
tcp_server.enable()
1757
2827
tcp_server.server_activate()
1759
2829
# Find out what port we got
1760
2830
service.port = tcp_server.socket.getsockname()[1]
1761
2831
if use_ipv6:
1762
logger.info(u"Now listening on address %r, port %d,"
1763
" flowinfo %d, scope_id %d"
1764
% tcp_server.socket.getsockname())
2832
logger.info("Now listening on address %r, port %d,"
2833
" flowinfo %d, scope_id %d",
2834
*tcp_server.socket.getsockname())
1765
2835
else: # IPv4
1766
logger.info(u"Now listening on address %r, port %d"
1767
% tcp_server.socket.getsockname())
2836
logger.info("Now listening on address %r, port %d",
2837
*tcp_server.socket.getsockname())
1768
2838
1769
2839
#service.interface = tcp_server.socket.getsockname()[3]
1770
2840
1772
2842
# From the Avahi example code
1773
2843
try:
1774
2844
service.activate()
1775
except dbus.exceptions.DBusException, error:
1776
logger.critical(u"DBusException: %s", error)
2845
except dbus.exceptions.DBusException as error:
2846
logger.critical("D-Bus Exception", exc_info=error)
1777
2847
cleanup()
1778
2848
sys.exit(1)
1779
2849
# End of Avahi example code
1783
2853
(tcp_server.handle_request
1784
2854
(*args[2:], **kwargs) or True))
1785
2855
1786
logger.debug(u"Starting main loop")
2856
logger.debug("Starting main loop")
1787
2857
main_loop.run()
1788
except AvahiError, error:
1789
logger.critical(u"AvahiError: %s", error)
2858
except AvahiError as error:
2859
logger.critical("Avahi Error", exc_info=error)
1790
2860
cleanup()
1791
2861
sys.exit(1)
1792
2862
except KeyboardInterrupt:
1793
2863
if debug:
1794
print >> sys.stderr
1795
logger.debug(u"Server received KeyboardInterrupt")
1796
logger.debug(u"Server exiting")
2864
print("", file=sys.stderr)
2865
logger.debug("Server received KeyboardInterrupt")
2866
logger.debug("Server exiting")
1797
2867
# Must run before the D-Bus bus name gets deregistered
1798
2868
cleanup()
1799
2869
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0