From f69801f4137389aa4aa5761f5d32542d9faa2913 Mon Sep 17 00:00:00 2001 From: Valentin Samir Date: Sat, 12 Dec 2015 17:30:46 +0100 Subject: [PATCH] Update README --- README.rst | 128 ++++++++++++++++++++++++++--------------------------- 1 file changed, 64 insertions(+), 64 deletions(-) diff --git a/README.rst b/README.rst index 12bf88f..2617008 100644 --- a/README.rst +++ b/README.rst @@ -60,90 +60,90 @@ All settings are optional. Add them to ``settings.py`` to customize ``django-cas Template settings: - * ``CAS_LOGIN_TEMPLATE``: Path to the template showed on ``/login`` then the user - is not autenticated. The default is ``"cas_server/login.html"``. - * ``CAS_WARN_TEMPLATE``: Path to the template showed on ``/login?service=…`` then - the user is authenticated and has asked to be warned before beeing connected - to a service. The default is ``"cas_server/warn.html"``. - * ``CAS_LOGGED_TEMPLATE``: Path to the template showed on ``/login`` then to user is - authenticated. The default is ``"cas_server/logged.html"``. - * ``CAS_LOGOUT_TEMPLATE``: Path to the template showed on ``/logout`` then to user - is being disconnected. The default is ``"cas_server/logout.html"`` - * ``CAS_REDIRECT_TO_LOGIN_AFTER_LOGOUT``: Should we redirect users to `/login` after they - logged out instead of displaying ``CAS_LOGOUT_TEMPLATE``. The default is ``False``. +* ``CAS_LOGIN_TEMPLATE``: Path to the template showed on ``/login`` then the user + is not autenticated. The default is ``"cas_server/login.html"``. +* ``CAS_WARN_TEMPLATE``: Path to the template showed on ``/login?service=…`` then + the user is authenticated and has asked to be warned before beeing connected + to a service. The default is ``"cas_server/warn.html"``. +* ``CAS_LOGGED_TEMPLATE``: Path to the template showed on ``/login`` then to user is + authenticated. The default is ``"cas_server/logged.html"``. +* ``CAS_LOGOUT_TEMPLATE``: Path to the template showed on ``/logout`` then to user + is being disconnected. The default is ``"cas_server/logout.html"`` +* ``CAS_REDIRECT_TO_LOGIN_AFTER_LOGOUT``: Should we redirect users to `/login` after they + logged out instead of displaying ``CAS_LOGOUT_TEMPLATE``. The default is ``False``. Authentication settings: - * ``CAS_AUTH_CLASS``: A dotted paths to a class implementing ``cas_server.auth.AuthUser``. - The default is ``"cas_server.auth.DjangoAuthUser"`` +* ``CAS_AUTH_CLASS``: A dotted paths to a class implementing ``cas_server.auth.AuthUser``. + The default is ``"cas_server.auth.DjangoAuthUser"`` - * ``CAS_PROXY_CA_CERTIFICATE_PATH``: Path to certificates authority file. Usually on linux - the local CAs are in ``/etc/ssl/certs/ca-certificates.crt``. The default is ``True`` which - tell requests to use its internal certificat authorities. Settings it to ``False`` should - disable all x509 certificates validation and MUST not be done in production. - x509 certificate validation is perform upon PGT issuance. +* ``CAS_PROXY_CA_CERTIFICATE_PATH``: Path to certificates authority file. Usually on linux + the local CAs are in ``/etc/ssl/certs/ca-certificates.crt``. The default is ``True`` which + tell requests to use its internal certificat authorities. Settings it to ``False`` should + disable all x509 certificates validation and MUST not be done in production. + x509 certificate validation is perform upon PGT issuance. - * ``CAS_SLO_MAX_PARALLEL_REQUESTS``: Maximum number of parallel single log out requests send. - If more requests need to be send, there are queued. The default is ``10``. +* ``CAS_SLO_MAX_PARALLEL_REQUESTS``: Maximum number of parallel single log out requests send. + If more requests need to be send, there are queued. The default is ``10``. Tickets validity settings: - * ``CAS_TICKET_VALIDITY``: Number of seconds the service tickets and proxy tickets are valid. - This is the maximal time between ticket issuance by the CAS and ticket validation by an - application. The default is ``60``. - * ``CAS_PGT_VALIDITY``: Number of seconds the proxy granting tickets are valid. - The default is ``3600`` (1 hour). - * ``CAS_TICKET_TIMEOUT``: Number of seconds a ticket is kept is the database before sending - Single Log Out request and being cleared. The default is ``86400`` (24 hours). +* ``CAS_TICKET_VALIDITY``: Number of seconds the service tickets and proxy tickets are valid. + This is the maximal time between ticket issuance by the CAS and ticket validation by an + application. The default is ``60``. +* ``CAS_PGT_VALIDITY``: Number of seconds the proxy granting tickets are valid. + The default is ``3600`` (1 hour). +* ``CAS_TICKET_TIMEOUT``: Number of seconds a ticket is kept is the database before sending + Single Log Out request and being cleared. The default is ``86400`` (24 hours). Tickets miscellaneous settings: - * ``CAS_TICKET_LEN``: Default ticket length. All CAS implementation MUST support ST and PT - up to 32 chars, PGT and PGTIOU up to 64 chars and it is RECOMMENDED that all tickets up - to 256 chars are supports. Here the default is ``64``. - * ``CAS_LT_LEN``: Length of the login tickets. Login tickets are only processed by ``django-cas-server`` - thus there is no length restriction on it. The default is ``CAS_TICKET_LEN``. - * ``CAS_ST_LEN``: Length of the service tickets. The default is ``CAS_TICKET_LEN``. - You may need to lower is to ``32`` if you use some old clients. - * ``CAS_PT_LEN``: Length of the proxy tickets. The default is ``CAS_TICKET_LEN``. - This length should be the same as ``CAS_ST_LEN``. You may need to lower is to ``32`` - if you use some old clients. - * ``CAS_PGT_LEN``: Length of the proxy granting tickets. The default is ``CAS_TICKET_LEN``. - * ``CAS_PGTIOU_LEN``: Length of the proxy granting tickets IOU. The default is ``CAS_TICKET_LEN``. +* ``CAS_TICKET_LEN``: Default ticket length. All CAS implementation MUST support ST and PT + up to 32 chars, PGT and PGTIOU up to 64 chars and it is RECOMMENDED that all tickets up + to 256 chars are supports. Here the default is ``64``. +* ``CAS_LT_LEN``: Length of the login tickets. Login tickets are only processed by ``django-cas-server`` + thus there is no length restriction on it. The default is ``CAS_TICKET_LEN``. +* ``CAS_ST_LEN``: Length of the service tickets. The default is ``CAS_TICKET_LEN``. + You may need to lower is to ``32`` if you use some old clients. +* ``CAS_PT_LEN``: Length of the proxy tickets. The default is ``CAS_TICKET_LEN``. + This length should be the same as ``CAS_ST_LEN``. You may need to lower is to ``32`` + if you use some old clients. +* ``CAS_PGT_LEN``: Length of the proxy granting tickets. The default is ``CAS_TICKET_LEN``. +* ``CAS_PGTIOU_LEN``: Length of the proxy granting tickets IOU. The default is ``CAS_TICKET_LEN``. - * ``CAS_LOGIN_TICKET_PREFIX``: Prefix of login tickets. The default is ``"LT"``. - * ``CAS_SERVICE_TICKET_PREFIX``: Prefix of service tickets. The default is ``"ST"``. - The CAS specification mandate that service tickets MUST begin with the characters ST - so you should not change this. - * ``CAS_PROXY_TICKET_PREFIX``: Prefix of proxy ticket. The default is ``"ST"``. - * ``CAS_PROXY_GRANTING_TICKET_PREFIX``: Prefix of proxy granting ticket. The default is ``"PGT"``. - * ``CAS_PROXY_GRANTING_TICKET_IOU_PREFIX``: Prefix of proxy granting ticket IOU. The default is ``"PGTIOU"``. +* ``CAS_LOGIN_TICKET_PREFIX``: Prefix of login tickets. The default is ``"LT"``. +* ``CAS_SERVICE_TICKET_PREFIX``: Prefix of service tickets. The default is ``"ST"``. + The CAS specification mandate that service tickets MUST begin with the characters ST + so you should not change this. +* ``CAS_PROXY_TICKET_PREFIX``: Prefix of proxy ticket. The default is ``"ST"``. +* ``CAS_PROXY_GRANTING_TICKET_PREFIX``: Prefix of proxy granting ticket. The default is ``"PGT"``. +* ``CAS_PROXY_GRANTING_TICKET_IOU_PREFIX``: Prefix of proxy granting ticket IOU. The default is ``"PGTIOU"``. Mysql backend settings. Only usefull is you use the mysql authentication backend: - * ``CAS_SQL_HOST``: Host for the SQL server. The default is ``"localhost"``. - * ``CAS_SQL_USERNAME``: Username for connecting to the SQL server. - * ``CAS_SQL_PASSWORD``: Password for connecting to the SQL server. - * ``CAS_SQL_DBNAME``: Database name. - * ``CAS_SQL_DBCHARSET``: Database charset. The default is ``"utf8"`` - * ``CAS_SQL_USER_QUERY``: The query performed upon user authentication. - The username must be in field ``username``, the password in ``password``, - additional fields are used as the user attributs. - The default is ``"SELECT user AS usersame, pass AS password, users.* FROM users WHERE user = %s"`` - * ``CAS_SQL_PASSWORD_CHECK``: The method used to check the user password. Must be - ``"crypt"`` or ``"plain``". The default is ``"crypt"``. +* ``CAS_SQL_HOST``: Host for the SQL server. The default is ``"localhost"``. +* ``CAS_SQL_USERNAME``: Username for connecting to the SQL server. +* ``CAS_SQL_PASSWORD``: Password for connecting to the SQL server. +* ``CAS_SQL_DBNAME``: Database name. +* ``CAS_SQL_DBCHARSET``: Database charset. The default is ``"utf8"`` +* ``CAS_SQL_USER_QUERY``: The query performed upon user authentication. + The username must be in field ``username``, the password in ``password``, + additional fields are used as the user attributs. + The default is ``"SELECT user AS usersame, pass AS password, users.* FROM users WHERE user = %s"`` +* ``CAS_SQL_PASSWORD_CHECK``: The method used to check the user password. Must be + ``"crypt"`` or ``"plain``". The default is ``"crypt"``. Authentication backend ---------------------- ``django-cas-server`` comes with some authentication backends: - * dummy backend ``cas_server.auth.DummyAuthUser``: all authentication attempt fails. - * test backend ``cas_server.auth.TestAuthUser``: username is ``test`` and password is ``test`` - the returned attributs for the user are: ``{'nom': 'Nymous', 'prenom': 'Ano', 'email': 'anonymous@example.net'}`` - * django backend ``cas_server.auth.DjangoAuthUser``: Users are anthenticated agains django users system. - This is the default backend. The returned attributs are the fields available on the user model. - * mysql backend ``cas_server.auth.MysqlAuthUser``: see the 'Mysql backend settings' section. - The returned attributs are those return by sql query ``CAS_SQL_USER_QUERY``. +* dummy backend ``cas_server.auth.DummyAuthUser``: all authentication attempt fails. +* test backend ``cas_server.auth.TestAuthUser``: username is ``test`` and password is ``test`` + the returned attributs for the user are: ``{'nom': 'Nymous', 'prenom': 'Ano', 'email': 'anonymous@example.net'}`` +* django backend ``cas_server.auth.DjangoAuthUser``: Users are anthenticated agains django users system. + This is the default backend. The returned attributs are the fields available on the user model. +* mysql backend ``cas_server.auth.MysqlAuthUser``: see the 'Mysql backend settings' section. + The returned attributs are those return by sql query ``CAS_SQL_USER_QUERY``.