diff --git a/CHANGES b/CHANGES index 3be05e9..0a96096 100644 --- a/CHANGES +++ b/CHANGES @@ -1,6 +1,2 @@ -0.26p1 - bugs in forms.py fixed +1.0 - stand alone package 0.26 - comes with the googleauth suite -0.25 - added artnr2name filter -0.24 - Added forms.py, a generic approach for hudora specific address validation -0.23 - Added sites.py, a framework for internal and public URLs - diff --git a/Makefile b/Makefile index a6e8daf..90ab807 100644 --- a/Makefile +++ b/Makefile @@ -3,31 +3,27 @@ PATH := ./testenv/bin:$(PATH) default: dependencies check test statistics check: - find hudoratools -name '*.py' | xargs /usr/local/hudorakit/bin/hd_pep8 - /usr/local/hudorakit/bin/hd_pylint -f parseable hudoratools | tee pylint.out + find googleappsauth -name '*.py' | xargs /usr/local/hudorakit/bin/hd_pep8 + /usr/local/hudorakit/bin/hd_pylint -f parseable googleappsauth | tee .pylint.out install: build sudo python setup.py install -test: dependencies - DJANGO_SETTINGS_MODULE=settings PYTHONPATH=. python hudoratools/templatetags/hudoratools.py - DJANGO_SETTINGS_MODULE=settings PYTHONPATH=. python hudoratools/forms.py - dependencies: virtualenv testenv pip -q install -E testenv -r requirements.txt statistics: - sloccount --wide --details hudoratools | grep -E '^[0-9]' > sloccount.sc + sloccount --wide --details googleappsauth | grep -E '^[0-9]' > .sloccount.sc build: python setup.py build sdist bdist_egg upload: build - rsync dist/* root@cybernetics.hudora.biz:/usr/local/www/apache22/data/nonpublic/eggs/ + python setup.py sdist upload clean: - rm -Rf testenv build dist html test.db hudoratools.egg-info pylint.out sloccount.sc pip-log.txt + rm -Rf testenv build dist html test.db .pylint.out .sloccount.sc pip-log.txt find . -name '*.pyc' -or -name '*.pyo' -delete .PHONY: test build clean install upload check diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..8d337a6 --- /dev/null +++ b/README.markdown @@ -0,0 +1,48 @@ +# Authentication agains Google Apps Domains for Django + +*googleappsauth* allows you to authenticate your [Django][1] users against an Google Apps[2] domain. +This means you basically get a single sign-on solution, provided that all users of your django application +also have Accounts in Google Apps for your Domain. + +[1]: http://www.djangoproject.com/ +[2]: http://www.google.com/apps/ + +## Usage + +To use googleappsauth, configuration in `settings.py` should look like this: + + GOOGLE_APPS_DOMAIN = 'example.com' + GOOGLE_APPS_CONSUMER_KEY = 'example.com' + GOOGLE_APPS_CONSUMER_SECRET = '*sekret*' + GOOGLE_OPENID_ENDPOINT = 'https://www.google.com/a/%s/o8/ud?be=o8' % GOOGLE_APPS_DOMAIN + GOOGLE_API_SCOPE = 'http://www.google.com/m8/feeds/+http://docs.google.com/feeds/+http://spreadsheets.google.com/feeds/' + # domain where your application is running + GOOGLE_OPENID_REALM = 'http://*.hudora.biz/' + +You also have to tell googleappsauth where various views life: + + LOGIN_URL = '/login' + LOGIN_REDIRECT_URL = '/admin' + LOGOUT_URL = '/logout' + +To activate googleappsauth, set the appropriate Authentication backend and include a callback view. + + settings.py: + AUTHENTICATION_BACKENDS = ('googleappsauth.backends.GoogleAuthBackend',) + + urls.py: + (r'^callback_googleappsauth/', 'googleappsauth.views.callback'), + + +Using a special middleware which is included int he package, you can block access to a compete site. + + MIDDLEWARE_CLASSES = ( + 'django.middleware.common.CommonMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'googleappsauth.middleware.GoogleAuthMiddleware', + ) + +In addition you can set `AUTH_PROTECTED_AREAS` to authenticate only access to certain parts of a site, e.g. + + AUTH_PROTECTED_AREAS = '/admin' diff --git a/README.txt b/README.txt deleted file mode 100644 index ebaf7f6..0000000 --- a/README.txt +++ /dev/null @@ -1,4 +0,0 @@ -hudoratools - various Django related function for internal use at hudora. - -For stuff we publish see huDjango. - diff --git a/ez_setup.py b/ez_setup.py deleted file mode 100755 index d24e845..0000000 --- a/ez_setup.py +++ /dev/null @@ -1,276 +0,0 @@ -#!python -"""Bootstrap setuptools installation - -If you want to use setuptools in your package's setup.py, just include this -file in the same directory with it, and add this to the top of your setup.py:: - - from ez_setup import use_setuptools - use_setuptools() - -If you want to require a specific version of setuptools, set a download -mirror, or use an alternate download directory, you can do so by supplying -the appropriate options to ``use_setuptools()``. - -This file can also be run as a script to install or upgrade setuptools. -""" -import sys -DEFAULT_VERSION = "0.6c9" -DEFAULT_URL = "http://pypi.python.org/packages/%s/s/setuptools/" % sys.version[:3] - -md5_data = { - 'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca', - 'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb', - 'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b', - 'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a', - 'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618', - 'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac', - 'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5', - 'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4', - 'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c', - 'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b', - 'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27', - 'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277', - 'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa', - 'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e', - 'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e', - 'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f', - 'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2', - 'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc', - 'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167', - 'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64', - 'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d', - 'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20', - 'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab', - 'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53', - 'setuptools-0.6c7-py2.3.egg': '209fdf9adc3a615e5115b725658e13e2', - 'setuptools-0.6c7-py2.4.egg': '5a8f954807d46a0fb67cf1f26c55a82e', - 'setuptools-0.6c7-py2.5.egg': '45d2ad28f9750e7434111fde831e8372', - 'setuptools-0.6c8-py2.3.egg': '50759d29b349db8cfd807ba8303f1902', - 'setuptools-0.6c8-py2.4.egg': 'cba38d74f7d483c06e9daa6070cce6de', - 'setuptools-0.6c8-py2.5.egg': '1721747ee329dc150590a58b3e1ac95b', - 'setuptools-0.6c9-py2.3.egg': 'a83c4020414807b496e4cfbe08507c03', - 'setuptools-0.6c9-py2.4.egg': '260a2be2e5388d66bdaee06abec6342a', - 'setuptools-0.6c9-py2.5.egg': 'fe67c3e5a17b12c0e7c541b7ea43a8e6', - 'setuptools-0.6c9-py2.6.egg': 'ca37b1ff16fa2ede6e19383e7b59245a', -} - -import sys, os -try: from hashlib import md5 -except ImportError: from md5 import md5 - -def _validate_md5(egg_name, data): - if egg_name in md5_data: - digest = md5(data).hexdigest() - if digest != md5_data[egg_name]: - print >>sys.stderr, ( - "md5 validation of %s failed! (Possible download problem?)" - % egg_name - ) - sys.exit(2) - return data - -def use_setuptools( - version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir, - download_delay=15 -): - """Automatically find/download setuptools and make it available on sys.path - - `version` should be a valid setuptools version number that is available - as an egg for download under the `download_base` URL (which should end with - a '/'). `to_dir` is the directory where setuptools will be downloaded, if - it is not already available. If `download_delay` is specified, it should - be the number of seconds that will be paused before initiating a download, - should one be required. If an older version of setuptools is installed, - this routine will print a message to ``sys.stderr`` and raise SystemExit in - an attempt to abort the calling script. - """ - was_imported = 'pkg_resources' in sys.modules or 'setuptools' in sys.modules - def do_download(): - egg = download_setuptools(version, download_base, to_dir, download_delay) - sys.path.insert(0, egg) - import setuptools; setuptools.bootstrap_install_from = egg - try: - import pkg_resources - except ImportError: - return do_download() - try: - pkg_resources.require("setuptools>="+version); return - except pkg_resources.VersionConflict, e: - if was_imported: - print >>sys.stderr, ( - "The required version of setuptools (>=%s) is not available, and\n" - "can't be installed while this script is running. Please install\n" - " a more recent version first, using 'easy_install -U setuptools'." - "\n\n(Currently using %r)" - ) % (version, e.args[0]) - sys.exit(2) - else: - del pkg_resources, sys.modules['pkg_resources'] # reload ok - return do_download() - except pkg_resources.DistributionNotFound: - return do_download() - -def download_setuptools( - version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir, - delay = 15 -): - """Download setuptools from a specified location and return its filename - - `version` should be a valid setuptools version number that is available - as an egg for download under the `download_base` URL (which should end - with a '/'). `to_dir` is the directory where the egg will be downloaded. - `delay` is the number of seconds to pause before an actual download attempt. - """ - import urllib2, shutil - egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3]) - url = download_base + egg_name - saveto = os.path.join(to_dir, egg_name) - src = dst = None - if not os.path.exists(saveto): # Avoid repeated downloads - try: - from distutils import log - if delay: - log.warn(""" ---------------------------------------------------------------------------- -This script requires setuptools version %s to run (even to display -help). I will attempt to download it for you (from -%s), but -you may need to enable firewall access for this script first. -I will start the download in %d seconds. - -(Note: if this machine does not have network access, please obtain the file - - %s - -and place it in this directory before rerunning this script.) ----------------------------------------------------------------------------""", - version, download_base, delay, url - ); from time import sleep; sleep(delay) - log.warn("Downloading %s", url) - src = urllib2.urlopen(url) - # Read/write all in one block, so we don't create a corrupt file - # if the download is interrupted. - data = _validate_md5(egg_name, src.read()) - dst = open(saveto,"wb"); dst.write(data) - finally: - if src: src.close() - if dst: dst.close() - return os.path.realpath(saveto) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -def main(argv, version=DEFAULT_VERSION): - """Install or upgrade setuptools and EasyInstall""" - try: - import setuptools - except ImportError: - egg = None - try: - egg = download_setuptools(version, delay=0) - sys.path.insert(0,egg) - from setuptools.command.easy_install import main - return main(list(argv)+[egg]) # we're done here - finally: - if egg and os.path.exists(egg): - os.unlink(egg) - else: - if setuptools.__version__ == '0.0.1': - print >>sys.stderr, ( - "You have an obsolete version of setuptools installed. Please\n" - "remove it from your system entirely before rerunning this script." - ) - sys.exit(2) - - req = "setuptools>="+version - import pkg_resources - try: - pkg_resources.require(req) - except pkg_resources.VersionConflict: - try: - from setuptools.command.easy_install import main - except ImportError: - from easy_install import main - main(list(argv)+[download_setuptools(delay=0)]) - sys.exit(0) # try to force an exit - else: - if argv: - from setuptools.command.easy_install import main - main(argv) - else: - print "Setuptools version",version,"or greater has been installed." - print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)' - -def update_md5(filenames): - """Update our built-in md5 registry""" - - import re - - for name in filenames: - base = os.path.basename(name) - f = open(name,'rb') - md5_data[base] = md5(f.read()).hexdigest() - f.close() - - data = [" %r: %r,\n" % it for it in md5_data.items()] - data.sort() - repl = "".join(data) - - import inspect - srcfile = inspect.getsourcefile(sys.modules[__name__]) - f = open(srcfile, 'rb'); src = f.read(); f.close() - - match = re.search("\nmd5_data = {\n([^}]+)}", src) - if not match: - print >>sys.stderr, "Internal error!" - sys.exit(2) - - src = src[:match.start(1)] + repl + src[match.end(1):] - f = open(srcfile,'w') - f.write(src) - f.close() - - -if __name__=='__main__': - if len(sys.argv)>2 and sys.argv[1]=='--md5update': - update_md5(sys.argv[2:]) - else: - main(sys.argv[1:]) - - - - - - diff --git a/hudoratools/googleauth/__init__.py b/googleappsauth/__init__.py similarity index 100% rename from hudoratools/googleauth/__init__.py rename to googleappsauth/__init__.py diff --git a/hudoratools/googleauth/backends.py b/googleappsauth/backends.py similarity index 100% rename from hudoratools/googleauth/backends.py rename to googleappsauth/backends.py diff --git a/hudoratools/googleauth/middleware.py b/googleappsauth/middleware.py similarity index 100% rename from hudoratools/googleauth/middleware.py rename to googleappsauth/middleware.py diff --git a/hudoratools/googleauth/oauth.py b/googleappsauth/oauth.py similarity index 100% rename from hudoratools/googleauth/oauth.py rename to googleappsauth/oauth.py diff --git a/hudoratools/googleauth/openid.py b/googleappsauth/openid.py similarity index 100% rename from hudoratools/googleauth/openid.py rename to googleappsauth/openid.py diff --git a/hudoratools/googleauth/utils.py b/googleappsauth/utils.py similarity index 100% rename from hudoratools/googleauth/utils.py rename to googleappsauth/utils.py diff --git a/hudoratools/googleauth/views.py b/googleappsauth/views.py similarity index 100% rename from hudoratools/googleauth/views.py rename to googleappsauth/views.py diff --git a/requirements.txt b/requirements.txt index e9610cc..fd7992b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,2 @@ -Django==1.0.2-final --f https://cybernetics.hudora.biz/nonpublic/eggs/ -cs -huTools>=0.39p3 +setuptools +Django>-1.0.2-final diff --git a/settings.py b/settings.py deleted file mode 100644 index 82858e7..0000000 --- a/settings.py +++ /dev/null @@ -1,92 +0,0 @@ -# -*- coding: utf-8 -*- -""" -TESTING SETTINGS for django. - -Copyright (c) HUDORA. All rights reserved. -""" - -# See http://docs.djangoproject.com/en/dev/ref/settings/ for inspiration - -import os -import django - -# calculated paths for django and the site -# used as starting points for various other paths -DJANGO_ROOT = os.path.dirname(os.path.realpath(django.__file__)) -SITE_ROOT = os.path.dirname(os.path.realpath(__file__)) - -DEBUG = True -TEMPLATE_DEBUG = True -TEMPLATE_STRING_IF_INVALID = "_#_%s_#_" -DEBUG_PROPAGATE_EXCEPTIONS = True - -MEDIA_URL = 'http://s.hdimg.net/huLOG/' - -# for testing -DATABASE_ENGINE = 'sqlite3' -DATABASE_NAME = os.path.join(SITE_ROOT, 'test.db') - -ROOT_URLCONF = 'huLOG.urls' -SITE_ID = 1 # intern.hudora.biz - -INSTALLED_APPS = ( - 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', - 'django.contrib.admin', 'django.contrib.comments', 'django.contrib.markup', - #'debug_toolbar', - 'hudoratools', -) - -TEMPLATE_DIRS = (os.path.join(SITE_ROOT, 'generic_templates')) - -TEMPLATE_CONTEXT_PROCESSORS = ( - 'django.core.context_processors.auth', 'django.core.context_processors.debug', - 'django.core.context_processors.i18n', 'django.core.context_processors.media', -) - -TEMPLATE_LOADERS = ( - 'django.template.loaders.filesystem.load_template_source', - 'django.template.loaders.app_directories.load_template_source', - 'django.template.loaders.eggs.load_template_source', -) - -MIDDLEWARE_CLASSES = ( - #'debug_toolbar.middleware.DebugToolbarMiddleware', - 'hudjango.middleware.clienttrack.ClientTrackMiddleware', - 'django.middleware.common.CommonMiddleware', - 'django.contrib.sessions.middleware.SessionMiddleware', - 'django.contrib.auth.middleware.AuthenticationMiddleware', -) - - -# This example is all working panels, not all are active with default settings -# DEBUG_TOOLBAR_PANELS = ( -# 'debug_toolbar.panels.sql.SQLDebugPanel', -# 'debug_toolbar.panels.headers.HeaderDebugPanel', -# 'debug_toolbar.panels.cache.CacheDebugPanel', -# 'debug_toolbar.panels.profiler.ProfilerDebugPanel', -# 'debug_toolbar.panels.request_vars.RequestVarsDebugPanel', -# 'debug_toolbar.panels.settings_vars.SettingsVarsDebugPanel', -# 'debug_toolbar.panels.templates.TemplatesDebugPanel', -# # If you are using the profiler panel you don't need the timer -# # 'debug_toolbar.panels.timer.TimerDebugPanel', -# ) - -ADMIN_MEDIA_PREFIX = 'http://s.hdimg.net/djangoadmin/1.0.2/' -INTERNAL_IPS = ('127.0.0.1') -TIME_FORMAT = 'H:i' -TIME_ZONE = 'Europe/Amsterdam' -DATETIME_FORMAT = 'Y-m-d H:i:s' -DATE_FORMAT = 'Y-m-d' -USE_I18N = True -LANGUAGE_CODE = 'de-de' -LANGUAGES = ( - ('zh', 'Chinese'), - ('de', 'German'), - ('en', 'English'), -) - -SECRET_KEY = 'sua1+khy2x-dojd_+r2j^7$asdfasQ@#$)!v94tpxe-g&_n6xxxv0!f+y' -CACHE_BACKEND = 'memcached://balancer.local.hudora.biz:11211/' -os.environ['PYJASPER_SERVLET_URL'] = 'http://jasper.local.hudora.biz:8080/pyJasper/jasper.py' -COUCHDB_STORAGE_OPTIONS = {'server': "http://couchdb1.local.hudora.biz:5984"} -PREPEND_WWW = False diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 4411de1..0000000 --- a/setup.cfg +++ /dev/null @@ -1,3 +0,0 @@ -[egg_info] -#tag_build = .dev -tag_svn_revision = 1 diff --git a/setup.py b/setup.py index bdbf4ff..139da19 100644 --- a/setup.py +++ b/setup.py @@ -1,18 +1,14 @@ -from ez_setup import use_setuptools -use_setuptools() -from setuptools import setup, find_packages +import codecs -setup(name='hudoratools', +setup(name='googleappsauth', maintainer='Maximillian Dornseif', maintainer_email='md@hudora.de', - version='0.26p3', - url='https://cybernetics.hudora.biz/nonpublic/eggs/', - description='hudoratools', - long_description="Django support tools for internal use at HUDORA.", + version='1.0', + description='googleappsauth authenticates Django Users against a Google Apps Domain', + long_description=codecs.open('README.markdown', "r", "utf-8").read() license='BSD', - #classifiers=['Intended Audience :: Developers', - # 'Programming Language :: Python'], - + classifiers=['Intended Audience :: Developers', + 'Programming Language :: Python'], packages = find_packages(), package_data = { # If any package contains *.txt or *.rst files, include them: