@@ -33,13 +33,13 @@ will also install PySAML2 and its dependencies automatically.
33
33
Configuration
34
34
=============
35
35
36
- There are three things you need to setup to make djangosaml2 works in your
36
+ There are three things you need to setup to make djangosaml2 work in your
37
37
Django project:
38
38
39
39
1. **settings.py ** as you may already know, it is the main Django
40
40
configuration file.
41
41
2. **urls.py ** is the file where you will include djangosaml2 urls.
42
- 3. **pysaml2 ** specific files such as a attribute map directory and a
42
+ 3. **pysaml2 ** specific files such as an attribute map directory and a
43
43
certificate.
44
44
45
45
@@ -69,7 +69,7 @@ do to make sure it is compatible with your Django version and environment.
69
69
as you run any other Django application test suite. Just type
70
70
``python manage.py test djangosaml2 ``
71
71
72
- Then you have to add the djangosaml2.backends.Saml2Backend
72
+ Then you have to add the `` djangosaml2.backends.Saml2Backend ``
73
73
authentication backend to the list of authentications backends.
74
74
By default only the ModelBackend included in Django is configured.
75
75
A typical configuration would look like this::
@@ -89,7 +89,7 @@ A typical configuration would look like this::
89
89
djangosaml2 0.5.0 it is now possible to define such
90
90
backends.
91
91
92
- Finally we have to tell Django what is the new login url we want to use::
92
+ Finally we have to tell Django what the new login url we want to use is ::
93
93
94
94
LOGIN_URL = '/saml2/login/'
95
95
SESSION_EXPIRE_AT_BROWSER_CLOSE = True
@@ -114,7 +114,7 @@ view to the ``/saml2/login/`` view.
114
114
Changes in the urls.py file
115
115
---------------------------
116
116
117
- The next thing you need to do is to include ``djangosaml2.urls `` module to your
117
+ The next thing you need to do is to include ``djangosaml2.urls `` module in your
118
118
main ``urls.py `` module::
119
119
120
120
urlpatterns = patterns(
@@ -269,9 +269,10 @@ metadata for remote entities. Usually the easiest type is the ``local`` where
269
269
you just put the name of a local XML file with the contents of the remote
270
270
entities metadata. This XML file should be in the SAML2 metadata format.
271
271
272
- The ``key_file `` and ``cert_file `` options references the two parts of a
273
- standard x509 certificate. You need it to sign your metadata an to encrypt
274
- and decrypt the SAML2 assertions.
272
+ The ``key_file `` and ``cert_file `` options reference the two parts of a
273
+ standard x509 certificate. You need it to sign your metadata. For assertion
274
+ encryption/decryption support please configure another set of ``key_file `` and
275
+ ``cert_file ``, but as inner attribues of ``encryption_keypairs `` option.
275
276
276
277
.. note ::
277
278
@@ -308,13 +309,13 @@ When such assertion is received on the Django side it is used to find
308
309
a Django user and create a session for it. By default djangosaml2 will
309
310
do a query on the User model with the 'username' attribute but you can
310
311
change it to any other attribute of the User model. For example,
311
- you can do this look up using the 'email' attribute. In order to do so
312
+ you can do this lookup using the 'email' attribute. In order to do so
312
313
you should set the following setting::
313
314
314
315
SAML_DJANGO_USER_MAIN_ATTRIBUTE = 'email'
315
316
316
317
Please, use an unique attribute when setting this option. Otherwise
317
- the authentication process will fail because djangosaml2 does not know
318
+ the authentication process may fail because djangosaml2 will not know
318
319
which Django user it should pick.
319
320
320
321
If your main attribute is something inherently case-inensitive (such as
0 commit comments