Changeset 8123 for trunk/ndg_oauth/ndg_oauth_server

Timestamp:

24/08/12 16:23:04 (9 years ago)

Author:

pjkersha

Message:

0.3.0 Release

• Added READMEs and updated setup.py doc

Location:

trunk/ndg_oauth/ndg_oauth_server

Files:

• . (modified) (1 prop)
• ndg/oauth/server/examples/README (modified) (1 diff)
• ndg/oauth/server/examples/bearer_tok/README (added)
• ndg/oauth/server/examples/slcs/README (added)
• ndg/oauth/server/examples/slcs/slcs_server_app.ini (modified) (1 diff)
• setup.cfg (modified) (1 diff)
• setup.py (modified) (3 diffs)

trunk/ndg_oauth/ndg_oauth_server

@@ -1 +1 @@
 authn
+dist
+ndg_oauth_server.egg-info

@@ -1 +1 @@
 authn
+dist
+ndg_oauth_server.egg-info

trunk/ndg_oauth/ndg_oauth_server/ndg/oauth/server/examples/README

@@ -3 +3 @@
 ini file which sets the combination of middleware and config settings needed.
 
-ceda/ -             standard oauth usage
+bearer_tok/ -       uses string-based bearer tokens
 
 slcs/ -             short-lived credential service returns an X.509 cert as 
                     token.  It uses MyProxy as a backend service to issue certs.  
-                    A test MyProxyCA service is needed for this configured with 
-                    a custom PAM to allow of a global password. See: 
+                    A test MyProxyCA service (see 
+                    http://grid.ncsa.illinois.edu/myproxy/ca/) is needed for 
+                    this configured with a custom PAM to allow of a global
+                    password. See: 
                     http://ndg-security.ceda.ac.uk/browser/trunk/MashMyData/pam_credential_translation
 
 shared_config/ -    contains config files used by all example configurations
+
+These examples should be used with their equivalent client apps in 
+ndg.oauth.client.examples

trunk/ndg_oauth/ndg_oauth_server/ndg/oauth/server/examples/slcs/slcs_server_app.ini

@@ -27 +27 @@
            OAuth2Authz
            OAuth2ServerFilterApp
-#           OAuth2Server
 
 # This filter sets up a server side session linked to a cookie.  The session

trunk/ndg_oauth/ndg_oauth_server/setup.cfg

@@ -1 +1 @@
 [egg_info]
 #tag_build = dev
-tag_svn_revision = true
+tag_svn_revision = false

trunk/ndg_oauth/ndg_oauth_server/setup.py

@@ -16 +16 @@
 This is an OAuth 2.0 server library and WSGI middleware filter.
 
+It supports simple string-based bearer token and a custom extension to enable 
+the use of X.509 certificates as tokens.  The latter has been added for a
+specialised use case to enable a SLCS (Short-lived Credential Service) to issue 
+delegated X.509-based credentials with OAuth.
+
 Prerequisites
 =============
-This has been developed and tested for Python 2.6.
+This has been developed and tested for Python 2.6 and 2.7.
 
 Installation
@@ -26 +31 @@
 Configuration
 =============
-An example of configuration is provided in the file development.ini. This
-configures the components needed to authenticate users, obtain user
-authorisation for an OAuth client and obtain a certificate to use as an access
-token using MyProxyClient.
+Examples are contained in the examples/ sub-folder:
+
+bearer_tok/:
+  This configures a simple test application that uses string based tokens.
+slcs/:
+  This is a more complex and specialised example that issues X.509 certificate-
+  based tokens as part of a Short-lived Credential Service.  The authorisation
+  server requires access to a specially configured MyProxyCA service (
+  http://grid.ncsa.illinois.edu/myproxy/ca/) configured with a custom PAM to 
+  allow issue of credentials. See: 
+  http://ndg-security.ceda.ac.uk/browser/trunk/MashMyData/pam_credential_translation
+  
+The examples should be used in conjunction with the ndg.oauth client package.
 """
 
 setup(
     name =                      'ndg_oauth_server',
-    version =                   '0.2.0',
-    description =               'OAuth 2.0 server providing MyProxy certificates as access tokens',
+    version =                   '0.3.0',
+    description =               'OAuth 2.0 server providing MyProxy '
+                                'certificates as access tokens',
     long_description =          _long_description,
     author =                    'R. B. Wilkinson',
-    maintainer =                'Philip Kershaw',
+    maintainer =                    'Philip Kershaw',
     maintainer_email =          'Philip.Kershaw@stfc.ac.uk',
     #url ='',
@@ -47 +62 @@
         "WebOb",
         "repoze.who",
-        "MyProxyWebService",
         "Genshi",
     ],
-    packages =find_packages(),
-    zip_safe =False,
+    extras_require = {'slcs_support': 'MyProxyClient'},
+    packages = find_packages(),
+    zip_safe = False,
 )

@@ -1 +1 @@
 authn
+dist
+ndg_oauth_server.egg-info