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