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