README.rst

   1 ===================
   2 django-cas-provider
   3 ===================
   4
   5 OVERVIEW
   6 =========
   7
   8 django-cas-provider is a provider for the `Central Authentication Service <http://jasig.org/cas>`_. It supports CAS version 1.0 and parts of CAS version 2.0 protocol. It allows remote services to authenticate users for the purposes of Single Sign-On (SSO). For example, a user logs into a CAS server
   9 (provided by django-cas-provider) and can then access other services (such as email, calendar, etc) without re-entering her password for each service. For more details, see the `CAS wiki <http://www.ja-sig.org/wiki/display/CAS/Home>`_ and `Single Sign-On on Wikipedia <http://en.wikipedia.org/wiki/Single_Sign_On>`_.
  10
  11 INSTALLATION
  12 =============
  13
  14 To install, run the following command from this directory::
  15
  16     python setup.py install
  17
  18 Or, put `cas_provider` somewhere on your Python path.
  19
  20 If you want use CAS v.2 protocol or above, you must install `lxml` package to correct work.
  21
  22 USAGE
  23 ======
  24
  25 #. Add ``'cas_provider'`` to your ``INSTALLED_APPS`` tuple in *settings.py*.
  26 #. In *settings.py*, set ``LOGIN_URL`` to ``'/cas/login/'`` and ``LOGOUT_URL`` to ``'/cas/logout/'``
  27 #. In *urls.py*, put the following line: ``(r'^cas/', include('cas_provider.urls')),``
  28 #. Create login/logout templates (or modify the samples)
  29 #. Use 'cleanuptickets' management command to clean up expired tickets
  30
  31 SETTINGS
  32 =========
  33
  34 CAS_TICKET_EXPIRATION - minutes to tickets expiration. Default is 5 minutes.
  35
  36 CAS_CUSTOM_ATTRIBUTES_CALLBACK - name of callback to provide dictionary with
  37 extended user attributes (may be used in CAS v.2 or above). Default is None.
  38
  39 CAS_CUSTOM_ATTRIBUTES_FORMAT - name of custom attribute formatter callback will be
  40 used to format custom user attributes. This package provide module `attribute_formatters`
  41 with formatters for common used formats. Available formats styles are `RubyCAS`, `Jasig`
  42 and `Name-Value. Default is Jasig style. See module source code for more details.
  43
  44 CAS_AUTO_REDIRECT_AFTER_LOGOUT - If False (default behavior, specified in CAS protocol)
  45 after successful logout notification page will be shown. If it's True, after successful logout will
  46 be auto redirect back to service without any notification.
  47
  48
  49 PROTOCOL DOCUMENTATION
  50 =====================
  51
  52 * `CAS Protocol <http://www.jasig.org/cas/protocol>`
  53 * `CAS 1 Architecture <http://www.jasig.org/cas/cas1-architecture>`
  54 * `CAS 2 Architecture <http://www.jasig.org/cas/cas2-architecture>`
  55 * `Proxy Authentication <http://www.jasig.org/cas/proxy-authentication>`
  56 * `CAS – Central Authentication Service <http://www.jusfortechies.com/cas/overview.html>`
  57 * `Proxy CAS Walkthrough <https://wiki.jasig.org/display/CAS/Proxy+CAS+Walkthrough>`
  58
  59 PROVIDED VIEWS
  60 =============
  61
  62 login
  63 ---------
  64
  65 It has not required arguments.
  66
  67 Optional arguments:
  68
  69 * template_name - login form template name (default is 'cas/login.html')
  70 * success_redirect - redirect after successful login if service GET argument is not provided
  71    (default is settings.LOGIN_REDIRECT_URL)
  72 * warn_template_name - warning page template name to allow login user to service if he
  73   already authenticated in SSO (default is 'cas/warn.html')
  74
  75 If request.GET has 'warn' argument and user has already authenticated in SSO it shows
  76 warning message instead of generate Service Ticket and redirect.
  77
  78 logout
  79 -----------
  80
  81 This destroys a client's single sign-on CAS session. The ticket-granting cookie is destroyed,
  82 and subsequent requests to login view will not obtain service tickets until the user again
  83 presents primary credentials (and thereby establishes a new single sign-on session).
  84
  85 It has not required arguments.
  86
  87 Optional arguments:
  88
  89 * template_name - template name for page with successful logout message (default is 'cas/logout.html')
  90
  91 validate
  92 -------------
  93
  94 It checks the validity of a service ticket. It is part of the CAS 1.0 protocol and thus does
  95 not handle proxy authentication.
  96
  97 It has not arguments.
  98
  99 service_validate
 100 -------------------------
 101
 102 It checks the validity of a service ticket and returns an XML-fragment response via CAS 2.0 protocol.
 103 Work with proxy is not supported yet.
 104
 105 It has not arguments.
 106
 107
 108 CUSTOM USER ATTRIBUTES FORMAT
 109 ===========================
 110
 111 Custom attribute format style may be changed in project settings with
 112 CAS_CUSTOM_ATTRIBUTES_FORMAT constant. You can provide your own formatter callback
 113 or specify existing in this package in `attribute_formatters` module.
 114
 115 Attribute formatter callback takes two arguments:
 116
 117 *  `auth_success` - `cas:authenticationSuccess` node. It is `lxml.etree.SubElement`instance;
 118 *  `attrs` - dictionary with user attributes received from callback specified in
 119     CAS_CUSTOM_ATTRIBUTES_CALLBACK in project settings.
 120
 121 Example of generated XML below::
 122
 123      <cas:serviceResponse xmlns:cas='http://www.yale.edu/tp/cas'>
 124          <cas:authenticationSuccess>
 125              <cas:user>jsmith</cas:user>
 126
 127              <!-- extended user attributes wiil be here -->
 128
 129              <cas:proxyGrantingTicket>PGTIOU-84678-8a9d2sfa23casd</cas:proxyGrantingTicket>
 130          </cas:authenticationSuccess>
 131      </cas:serviceResponse>
 132
 133
 134 * Name-Value style (provided in `cas_provider.attribute_formatters.name_value`)::
 135
 136     <cas:attribute name='attraStyle' value='Name-Value' />
 137     <cas:attribute name='surname' value='Smith' />
 138     <cas:attribute name='givenName' value='John' />
 139     <cas:attribute name='memberOf' value='CN=Staff,OU=Groups,DC=example,DC=edu' />
 140     <cas:attribute name='memberOf' value='CN=Spanish Department,OU=Departments,OU=Groups,DC=example,DC=edu' />
 141
 142
 143 *  Jasig Style attributes (provided in `cas_provider.attribute_formatters.jasig`)::
 144
 145     <cas:attributes>
 146         <cas:attraStyle>Jasig</cas:attraStyle>
 147         <cas:surname>Smith</cas:surname>
 148         <cas:givenName>John</cas:givenName>
 149         <cas:memberOf>CN=Staff,OU=Groups,DC=example,DC=edu</cas:memberOf>
 150         <cas:memberOf>CN=Spanish Department,OU=Departments,OU=Groups,DC=example,DC=edu</cas:memberOf>
 151     </cas:attributes>
 152
 153
 154 * RubyCAS style (provided in `cas_provider.attribute_formatters.ruby_cas`)::
 155
 156     <cas:attraStyle>RubyCAS</cas:attraStyle>
 157     <cas:surname>Smith</cas:surname>
 158     <cas:givenName>John</cas:givenName>
 159     <cas:memberOf>CN=Staff,OU=Groups,DC=example,DC=edu</cas:memberOf>
 160     <cas:memberOf>CN=Spanish Department,OU=Departments,OU=Groups,DC=example,DC=edu</cas:memberOf>
 161