Initial Commit

gssapi-console.py was extracted from python-gssapi and split into
several different parts.  A README was added, as well as a setup.py
file which installs a runnable script.

Author: DirectXMan12

.gitignore

@@ -0,0 +1,13 @@
+*.egg-info
+*.egg
+*~
+*.pyc
+/build/
+*.swp
+*.swo
+*.so
+.tox
+dist
+**/__pycache__
+.eggs
+.venv

LICENSE.txt

@@ -0,0 +1,5 @@
+Copyright (c) 2015, The Python GSSAPI Team
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

MANIFEST.in

@@ -0,0 +1,2 @@
+include *.txt
+include *.md

README.md

@@ -0,0 +1,32 @@
+GSSAPI Console
+==============
+
+*GSSAPI Console* allows provides an easy way to test out Python applications
+using GSSAPI in a self-contained environment.
+
+By default, the console will set up a self-contained MIT krb5 environment.
+However, other GSSAPI environments are planned.
+
+Requirements
+------------
+
+* [python-gssapi](https://pypi.python.org/pypi/gssapi) >= 1.1.0
+* The required components for the environment in used
+  (for krb5, the full set of MIT krb5 executables are needed,
+  including those required to set up a KDC).
+
+Usage
+-----
+
+*[further information is available by running `gssapi-console.py --help`]*
+
+The main executable of GSSAPI Console is `gssapi-console.py`.  The basic
+invocation works just like launching `python` -- use `gssapi-console.py FILE`
+to run a file in the established environment, or just run `gssapi-console.py`
+or `gssapi-console.py -i` to get an interactive environment (the `-i` flag
+can be used with a file, just like `python FILE -i`).
+
+You can use `--realm-args key1=true,key2=false,...` to pass specific arguments
+to the realm constructor (the set of such keys is driver-dependent), and
+`--mech MECH_NAME` can be used to specify a different driver (currently
+only `--mech krb5` will work).

gssapi-console.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python
+
+# interactive console with easy access to krb5 test harness stuff
+
+import argparse
+import os
+import sys
+import copy
+
+import pkg_resources as pkgres
+
+from gssapi_console import GSSAPIConsole
+
+
+parser = argparse.ArgumentParser(
+    description='An interactive Python console with krb5 setup')
+parser.add_argument('file', metavar='FILE', nargs='?',
+                    help='a file to run', default=None)
+parser.add_argument('-i', default=False, dest='force_interactive',
+                    action='store_const', const=True,
+                    help='Force interactive mode when running with a file')
+parser.add_argument('--realm-args', default=None,
+                    help='A comma-separated list of key=(true|false) values '
+                         'to pass to the realm constructor')
+parser.add_argument('--mech', default='krb5',
+                    help='Which environment to setup up '
+                         '(supports krb5 [default])')
+
+PARSED_ARGS = parser.parse_args()
+
+realm_args = {}
+if PARSED_ARGS.realm_args:
+    for arg in PARSED_ARGS.realm_args.split(','):
+        key, raw_val = arg.split('=')
+        realm_args[key] = (raw_val.lower() == 'true')
+
+try:
+    mech_cls_loader = next(
+        pkgres.iter_entry_points('gssapi_console.drivers',
+                                 name=PARSED_ARGS.mech))
+except StopIteration:
+    sys.exit('The %s environment is not supported by the '
+             'GSSAPI console' % PARSED_ARGS.mech)
+
+mech_cls = mech_cls_loader.load()
+console = GSSAPIConsole(mech_cls, realm_args=realm_args)
+
+SAVED_ENV = None
+
+try:
+    # import the env
+    SAVED_ENV = copy.deepcopy(os.environ)
+    for k, v in console.realm.env.items():
+        os.environ[k] = v
+
+    INTER = True
+    # run the interactive interpreter
+    if PARSED_ARGS.file is not None:
+        if not PARSED_ARGS.force_interactive:
+            INTER = False
+
+        with open(PARSED_ARGS.file) as src:
+            console.runsource(src.read(), src.name, 'exec')
+
+    if INTER:
+        console.interact()
+
+except (KeyboardInterrupt, EOFError):
+    pass
+finally:
+    # restore the env
+    if SAVED_ENV is not None:
+        for k in copy.deepcopy(os.environ):
+            if k in SAVED_ENV:
+                os.environ[k] = SAVED_ENV[k]
+            else:
+                del os.environ[k]
+
+    console.realm.stop()

gssapi_console/__init__.py

@@ -0,0 +1,2 @@
+from gssapi_console.core import GSSAPIConsole  # noqa
+from gssapi_console.drivers import GSSAPIConsoleDriver  # noqa

gssapi_console/core.py

@@ -0,0 +1,70 @@
+import code
+import os
+import sys
+
+
+READLINE_SRC = """
+# python startup file
+import readline
+import rlcompleter
+import atexit
+import os
+
+completer = rlcompleter.Completer(globals())
+readline.set_completer(completer.complete)
+
+# tab completion
+readline.parse_and_bind('Control-space: complete')
+# history file
+histfile = os.path.join(os.environ['HOME'], '.pythonhistory')
+try:
+    readline.read_history_file(histfile)
+except IOError:
+    pass
+
+atexit.register(readline.write_history_file, histfile)
+del os, histfile, readline, rlcompleter
+"""
+
+BANNER = """GSSAPI Interactive console
+Python {ver} on {platform}
+Type "help", "copyright", "credits" or "license" for more information about Python.
+
+Functions for controlling the realm are available in `REALM`.
+Mechansim: {mech} ({driver}), Realm: {realm}, User: {user}, Host: {host}"""
+
+
+class GSSAPIConsole(code.InteractiveConsole):
+    def __init__(self, driver_cls, use_readline=True, realm_args={}, *args, **kwargs):
+        code.InteractiveConsole.__init__(self, *args, **kwargs)
+
+        self._driver = driver_cls()
+        self.realm = self._driver.create_realm(realm_args)
+        self.locals['REALM'] = self.realm
+
+        self.runsource('import gssapi')
+        self.runsource('import gssapi.raw as gb')
+
+        if use_readline:
+            self._add_readline()
+
+        if os.environ.get('LD_LIBRARY_PATH'):
+            self.realm.env['LD_LIBRARY_PATH'] = os.environ['LD_LIBRARY_PATH']
+
+    def _add_readline(self):
+        self.runsource(READLINE_SRC, '<readline setup>', 'exec')
+
+    @property
+    def banner_text(self):
+        return BANNER.format(ver=sys.version, platform=sys.platform,
+                             mech=self._driver.MECH_NAME,
+                             driver=self._driver.PROVIDER_NAME,
+                             realm=self.realm.realm,
+                             user=self.realm.user_princ,
+                             host=self.realm.host_princ)
+
+    def interact(self, banner=None):
+        if banner is None:
+            banner = self.banner_text
+
+        super(GSSAPIConsole, self).interact(banner)

gssapi_console/drivers.py

@@ -0,0 +1,21 @@
+import sys
+
+
+class GSSAPIConsoleDriver(object):
+    MECH_NAME = ''
+    PROVIDER_NAME = ''
+
+    def create_realm(self, realm_args):
+        return None
+
+
+class Krb5Console(GSSAPIConsoleDriver):
+    MECH_NAME = 'krb5'
+    PROVIDER_NAME = 'MIT Kerberos 5'
+
+    def __init__(self):
+        __import__('gssapi.tests.k5test')
+        self._k5test = sys.modules['gssapi.tests.k5test']
+
+    def create_realm(self, realm_args):
+        return self._k5test.K5Realm(**realm_args)

setup.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+from setuptools import setup
+
+
+setup(
+    name='gssapi_console',
+    version='1.0.0',
+    author='The Python GSSAPI Team',
+    author_email='sross@redhat.com',
+    packages=['gssapi_console'],
+    scripts=['gssapi-console.py'],
+    description='An interactive tool for testing Python GSSAPI programs',
+    long_description=open('README.md').read(),
+    license='LICENSE.txt',
+    url="https://github.com/pythongssapi/python-gssapi",
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.3',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: ISC License (ISCL)',
+        'Programming Language :: Python :: Implementation :: CPython',
+        'Topic :: Security',
+    ],
+    keywords=['gssapi', 'security'],
+    entry_points={
+        'gssapi_console.drivers': [
+            'krb5 = gssapi_console.drivers:Krb5Console',
+        ],
+    },
+    install_requires=[
+        'gssapi',
+        'six'
+    ]
+)

tox.ini

@@ -0,0 +1,13 @@
+# Tox (http://tox.testrun.org/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+envlist = py27,py33,py34
+
+[testenv]
+# NB(sross): disabling E225,E226,E227,E901 make pep8 think Cython is ok
+# NB(sross): disable E402 because of the GSSAPI="blah" lines needed by Cython
+commands =
+    ./gssapi-console.py []