2011-04-11 08:39:38 -05:00
|
|
|
#!/usr/bin/python
|
|
|
|
#
|
|
|
|
# Authors:
|
|
|
|
# Jakub Hrozek <jhrozek@redhat.com>
|
|
|
|
# Jan Cholasta <jcholast@redhat.com>
|
|
|
|
#
|
|
|
|
# Copyright (C) 2011 Red Hat
|
|
|
|
# see file 'COPYING' for use and warranty information
|
|
|
|
#
|
|
|
|
# This program is free software; you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU General Public License as published by
|
|
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
|
|
# (at your option) any later version.
|
|
|
|
#
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
# GNU General Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU General Public License
|
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
import os
|
|
|
|
import sys
|
|
|
|
from optparse import OptionParser
|
|
|
|
from fnmatch import fnmatch, fnmatchcase
|
|
|
|
|
2011-04-28 11:32:25 -05:00
|
|
|
try:
|
|
|
|
from pylint import checkers
|
|
|
|
from pylint.lint import PyLinter
|
|
|
|
from pylint.reporters.text import ParseableTextReporter
|
|
|
|
from pylint.checkers.typecheck import TypeChecker
|
|
|
|
from logilab.astng import Class, Instance, InferenceError
|
|
|
|
except ImportError:
|
|
|
|
print >> sys.stderr, "To use {0}, please install pylint.".format(sys.argv[0])
|
|
|
|
sys.exit(32)
|
2011-04-11 08:39:38 -05:00
|
|
|
|
|
|
|
# File names to ignore when searching for python source files
|
|
|
|
IGNORE_FILES = ('.*', '*~', '*.in', '*.pyc', '*.pyo')
|
2011-12-07 18:04:55 -06:00
|
|
|
IGNORE_PATHS = ('build', 'rpmbuild', 'dist', 'install/po/test_i18n.py', 'lite-server.py',
|
2011-04-28 11:32:25 -05:00
|
|
|
'make-lint', 'make-test', 'tests')
|
2011-04-11 08:39:38 -05:00
|
|
|
|
|
|
|
class IPATypeChecker(TypeChecker):
|
|
|
|
# 'class': ('generated', 'properties',)
|
|
|
|
ignore = {
|
2011-11-21 09:50:27 -06:00
|
|
|
'ipalib.base.NameSpace': ['find'],
|
|
|
|
'ipalib.cli.Collector': ['__options'],
|
|
|
|
'ipalib.config.Env': ['*'],
|
|
|
|
'ipalib.plugable.API': ['Command', 'Object', 'Method', 'Property',
|
|
|
|
'Backend', 'log', 'plugins'],
|
|
|
|
'ipalib.plugable.Plugin': ['Command', 'Object', 'Method', 'Property',
|
2011-04-11 08:39:38 -05:00
|
|
|
'Backend', 'env', 'debug', 'info', 'warning', 'error', 'critical',
|
2011-11-21 09:50:27 -06:00
|
|
|
'exception', 'context', 'log'],
|
|
|
|
'ipalib.plugins.baseldap.CallbackInterface': ['pre_callback',
|
|
|
|
'post_callback', 'exc_callback'],
|
|
|
|
'ipalib.plugins.misc.env': ['env'],
|
|
|
|
'ipalib.parameters.Param': ['cli_name', 'cli_short_name', 'label',
|
2011-04-11 08:39:38 -05:00
|
|
|
'doc', 'required', 'multivalue', 'primary_key', 'normalizer',
|
|
|
|
'default', 'default_from', 'create_default', 'autofill', 'query',
|
2011-11-21 09:50:27 -06:00
|
|
|
'attribute', 'include', 'exclude', 'flags', 'hint', 'alwaysask',
|
|
|
|
'sortorder', 'csv', 'csv_separator', 'csv_skipspace'],
|
|
|
|
'ipalib.parameters.Bool': ['truths', 'falsehoods'],
|
|
|
|
'ipalib.parameters.Int': ['minvalue', 'maxvalue'],
|
2012-01-17 04:19:00 -06:00
|
|
|
'ipalib.parameters.Decimal': ['minvalue', 'maxvalue', 'precision'],
|
2011-11-21 09:50:27 -06:00
|
|
|
'ipalib.parameters.Data': ['minlength', 'maxlength', 'length',
|
|
|
|
'pattern', 'pattern_errmsg'],
|
|
|
|
'ipalib.parameters.Enum': ['values'],
|
|
|
|
'ipalib.parameters.File': ['stdin_if_missing'],
|
|
|
|
'urlparse.SplitResult': ['netloc'],
|
2012-02-19 09:02:38 -06:00
|
|
|
'ipaserver.rpcserver.KerberosSession' : ['api', 'log', 'debug', 'info', 'warning', 'error', 'critical', 'exception'],
|
2012-02-28 07:41:07 -06:00
|
|
|
'ipaserver.rpcserver.HTTP_Status' : ['log', 'debug', 'info', 'warning', 'error', 'critical', 'exception'],
|
add session manager and cache krb auth
This patch adds a session manager and support for caching
authentication in the session. Major elements of the patch are:
* Add a session manager to support cookie based sessions which
stores session data in a memcached entry.
* Add ipalib/krb_utils.py which contains functions to parse ccache
names, format principals, format KRB timestamps, and a KRB_CCache
class which reads ccache entry and allows one to extract information
such as the principal, credentials, credential timestamps, etc.
* Move krb constants defined in ipalib/rpc.py to ipa_krb_utils.py so
that all kerberos items are co-located.
* Modify javascript in ipa.js so that the IPA.command() RPC call
checks for authentication needed error response and if it receives
it sends a GET request to /ipa/login URL to refresh credentials.
* Add session_auth_duration config item to constants.py, used to
configure how long a session remains valid.
* Add parse_time_duration utility to ipalib/util.py. Used to parse the
session_auth_duration config item.
* Update the default.conf.5 man page to document session_auth_duration
config item (also added documentation for log_manager config items
which had been inadvertantly omitted from a previous commit).
* Add SessionError object to ipalib/errors.py
* Move Kerberos protection in Apache config from /ipa to /ipa/xml and
/ipa/login
* Add SessionCCache class to session.py to manage temporary Kerberos
ccache file in effect for the duration of an RPC command.
* Adds a krblogin plugin used to implement the /ipa/login
handler. login handler sets the session expiration time, currently
60 minutes or the expiration of the TGT, whichever is shorter. It
also copies the ccache provied by mod_auth_kerb into the session
data. The json handler will later extract and validate the ccache
belonging to the session.
* Refactored the WSGI handlers so that json and xlmrpc could have
independent behavior, this also moves where create and destroy
context occurs, now done in the individual handler rather than the
parent class.
* The json handler now looks up the session data, validates the ccache
bound to the session, if it's expired replies with authenicated
needed error.
* Add documentation to session.py. Fully documents the entire process,
got questions, read the doc.
* Add exclusions to make-lint as needed.
2012-02-06 12:29:56 -06:00
|
|
|
'ipalib.krb_utils.KRB5_CCache' : ['log', 'debug', 'info', 'warning', 'error', 'critical', 'exception'],
|
2012-02-15 09:26:42 -06:00
|
|
|
'ipalib.session.AuthManager' : ['log', 'debug', 'info', 'warning', 'error', 'critical', 'exception'],
|
|
|
|
'ipalib.session.SessionAuthManager' : ['log', 'debug', 'info', 'warning', 'error', 'critical', 'exception'],
|
add session manager and cache krb auth
This patch adds a session manager and support for caching
authentication in the session. Major elements of the patch are:
* Add a session manager to support cookie based sessions which
stores session data in a memcached entry.
* Add ipalib/krb_utils.py which contains functions to parse ccache
names, format principals, format KRB timestamps, and a KRB_CCache
class which reads ccache entry and allows one to extract information
such as the principal, credentials, credential timestamps, etc.
* Move krb constants defined in ipalib/rpc.py to ipa_krb_utils.py so
that all kerberos items are co-located.
* Modify javascript in ipa.js so that the IPA.command() RPC call
checks for authentication needed error response and if it receives
it sends a GET request to /ipa/login URL to refresh credentials.
* Add session_auth_duration config item to constants.py, used to
configure how long a session remains valid.
* Add parse_time_duration utility to ipalib/util.py. Used to parse the
session_auth_duration config item.
* Update the default.conf.5 man page to document session_auth_duration
config item (also added documentation for log_manager config items
which had been inadvertantly omitted from a previous commit).
* Add SessionError object to ipalib/errors.py
* Move Kerberos protection in Apache config from /ipa to /ipa/xml and
/ipa/login
* Add SessionCCache class to session.py to manage temporary Kerberos
ccache file in effect for the duration of an RPC command.
* Adds a krblogin plugin used to implement the /ipa/login
handler. login handler sets the session expiration time, currently
60 minutes or the expiration of the TGT, whichever is shorter. It
also copies the ccache provied by mod_auth_kerb into the session
data. The json handler will later extract and validate the ccache
belonging to the session.
* Refactored the WSGI handlers so that json and xlmrpc could have
independent behavior, this also moves where create and destroy
context occurs, now done in the individual handler rather than the
parent class.
* The json handler now looks up the session data, validates the ccache
bound to the session, if it's expired replies with authenicated
needed error.
* Add documentation to session.py. Fully documents the entire process,
got questions, read the doc.
* Add exclusions to make-lint as needed.
2012-02-06 12:29:56 -06:00
|
|
|
'ipalib.session.SessionManager' : ['log', 'debug', 'info', 'warning', 'error', 'critical', 'exception'],
|
|
|
|
'ipalib.session.SessionCCache' : ['log', 'debug', 'info', 'warning', 'error', 'critical', 'exception'],
|
|
|
|
'ipalib.session.MemcacheSessionManager' : ['log', 'debug', 'info', 'warning', 'error', 'critical', 'exception'],
|
2011-04-11 08:39:38 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
def _related_classes(self, klass):
|
|
|
|
yield klass
|
|
|
|
for base in klass.ancestors():
|
|
|
|
yield base
|
|
|
|
|
|
|
|
def _class_full_name(self, klass):
|
|
|
|
return klass.root().name + '.' + klass.name
|
|
|
|
|
|
|
|
def _find_ignored_attrs(self, owner):
|
|
|
|
attrs = []
|
|
|
|
for klass in self._related_classes(owner):
|
|
|
|
name = self._class_full_name(klass)
|
|
|
|
if name in self.ignore:
|
|
|
|
attrs += self.ignore[name]
|
|
|
|
return attrs
|
|
|
|
|
|
|
|
def visit_getattr(self, node):
|
|
|
|
try:
|
2011-04-28 11:32:25 -05:00
|
|
|
inferred = list(node.expr.infer())
|
2011-04-11 08:39:38 -05:00
|
|
|
except InferenceError:
|
2011-04-28 11:32:25 -05:00
|
|
|
inferred = []
|
2011-04-11 08:39:38 -05:00
|
|
|
|
2011-04-28 11:32:25 -05:00
|
|
|
for owner in inferred:
|
2011-11-30 08:08:23 -06:00
|
|
|
if not isinstance(owner, Class) and type(owner) is not Instance:
|
2011-04-11 08:39:38 -05:00
|
|
|
continue
|
|
|
|
|
|
|
|
ignored = self._find_ignored_attrs(owner)
|
|
|
|
for pattern in ignored:
|
|
|
|
if fnmatchcase(node.attrname, pattern):
|
|
|
|
return
|
|
|
|
|
|
|
|
super(IPATypeChecker, self).visit_getattr(node)
|
|
|
|
|
|
|
|
class IPALinter(PyLinter):
|
|
|
|
ignore = (TypeChecker,)
|
|
|
|
|
2011-04-28 11:32:25 -05:00
|
|
|
def __init__(self):
|
|
|
|
super(IPALinter, self).__init__()
|
|
|
|
|
|
|
|
self.missing = set()
|
|
|
|
|
2011-04-11 08:39:38 -05:00
|
|
|
def register_checker(self, checker):
|
|
|
|
if type(checker) in self.ignore:
|
|
|
|
return
|
|
|
|
super(IPALinter, self).register_checker(checker)
|
|
|
|
|
2011-04-28 11:32:25 -05:00
|
|
|
def add_message(self, msg_id, line=None, node=None, args=None):
|
|
|
|
if line is None and node is not None:
|
|
|
|
line = node.fromlineno
|
2011-04-11 08:39:38 -05:00
|
|
|
|
2011-04-28 11:32:25 -05:00
|
|
|
# Record missing packages
|
|
|
|
if msg_id == 'F0401' and self.is_message_enabled(msg_id, line):
|
|
|
|
self.missing.add(args)
|
|
|
|
|
|
|
|
super(IPALinter, self).add_message(msg_id, line, node, args)
|
|
|
|
|
|
|
|
def find_files(path, basepath):
|
2011-04-11 08:39:38 -05:00
|
|
|
entries = os.listdir(path)
|
|
|
|
|
|
|
|
# If this directory is a python package, look no further
|
|
|
|
if '__init__.py' in entries:
|
|
|
|
return [path]
|
|
|
|
|
|
|
|
result = []
|
|
|
|
for filename in entries:
|
2011-04-28 11:32:25 -05:00
|
|
|
filepath = os.path.join(path, filename)
|
|
|
|
|
2011-04-11 08:39:38 -05:00
|
|
|
for pattern in IGNORE_FILES:
|
|
|
|
if fnmatch(filename, pattern):
|
|
|
|
filename = None
|
|
|
|
break
|
2011-04-28 11:32:25 -05:00
|
|
|
if filename is None:
|
2011-04-11 08:39:38 -05:00
|
|
|
continue
|
|
|
|
|
2011-04-28 11:32:25 -05:00
|
|
|
for pattern in IGNORE_PATHS:
|
|
|
|
patpath = os.path.join(basepath, pattern).replace(os.sep, '/')
|
|
|
|
if filepath == patpath:
|
|
|
|
filename = None
|
|
|
|
break
|
|
|
|
if filename is None:
|
|
|
|
continue
|
2011-04-11 08:39:38 -05:00
|
|
|
|
|
|
|
if os.path.islink(filepath):
|
|
|
|
continue
|
|
|
|
|
|
|
|
# Recurse into subdirectories
|
|
|
|
if os.path.isdir(filepath):
|
|
|
|
result += find_files(filepath, basepath)
|
|
|
|
continue
|
|
|
|
|
|
|
|
# Add all *.py files
|
|
|
|
if filename.endswith('.py'):
|
|
|
|
result.append(filepath)
|
|
|
|
continue
|
|
|
|
|
|
|
|
# Add any other files beginning with a shebang and having
|
|
|
|
# the word "python" on the first line
|
|
|
|
file = open(filepath, 'r')
|
|
|
|
line = file.readline(128)
|
|
|
|
file.close()
|
|
|
|
|
|
|
|
if line[:2] == '#!' and line.find('python') >= 0:
|
|
|
|
result.append(filepath)
|
|
|
|
|
|
|
|
return result
|
|
|
|
|
|
|
|
def main():
|
|
|
|
optparser = OptionParser()
|
|
|
|
optparser.add_option('--no-fail', help='report success even if errors were found',
|
|
|
|
dest='fail', default=True, action='store_false')
|
|
|
|
optparser.add_option('--enable-noerror', help='enable warnings and other non-error messages',
|
|
|
|
dest='errors_only', default=True, action='store_false')
|
|
|
|
|
|
|
|
options, args = optparser.parse_args()
|
|
|
|
cwd = os.getcwd()
|
|
|
|
|
|
|
|
if len(args) == 0:
|
|
|
|
files = find_files(cwd, cwd)
|
|
|
|
else:
|
|
|
|
files = args
|
|
|
|
|
|
|
|
for filename in files:
|
|
|
|
dirname = os.path.dirname(filename)
|
|
|
|
if dirname not in sys.path:
|
|
|
|
sys.path.insert(0, dirname)
|
|
|
|
|
|
|
|
linter = IPALinter()
|
|
|
|
checkers.initialize(linter)
|
|
|
|
linter.register_checker(IPATypeChecker(linter))
|
|
|
|
|
|
|
|
if options.errors_only:
|
|
|
|
linter.disable_noerror_messages()
|
2011-04-28 11:32:25 -05:00
|
|
|
linter.enable('F')
|
2011-04-11 08:39:38 -05:00
|
|
|
linter.set_reporter(ParseableTextReporter())
|
|
|
|
linter.set_option('include-ids', True)
|
|
|
|
linter.set_option('reports', False)
|
2011-04-28 11:32:25 -05:00
|
|
|
linter.set_option('persistent', False)
|
2011-04-11 08:39:38 -05:00
|
|
|
|
|
|
|
linter.check(files)
|
|
|
|
|
2011-04-28 11:32:25 -05:00
|
|
|
if linter.msg_status != 0:
|
|
|
|
print >> sys.stderr, """
|
|
|
|
===============================================================================
|
|
|
|
Errors were found during the static code check.
|
|
|
|
"""
|
|
|
|
|
|
|
|
if len(linter.missing) > 0:
|
|
|
|
print >> sys.stderr, "There are some missing imports:"
|
|
|
|
for mod in sorted(linter.missing):
|
|
|
|
print >> sys.stderr, " " + mod
|
|
|
|
print >> sys.stderr, """
|
|
|
|
Please make sure all of the required and optional (python-krbV, python-rhsm)
|
|
|
|
python packages are installed.
|
|
|
|
"""
|
|
|
|
|
|
|
|
print >> sys.stderr, """\
|
|
|
|
If you are certain that any of the reported errors are false positives, please
|
|
|
|
mark them in the source code according to the pylint documentation.
|
|
|
|
===============================================================================
|
|
|
|
"""
|
|
|
|
|
2011-04-11 08:39:38 -05:00
|
|
|
if options.fail:
|
|
|
|
return linter.msg_status
|
|
|
|
else:
|
|
|
|
return 0
|
|
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
sys.exit(main())
|