ynerant/django-cas-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #60 from nitmir/dev

Browse Source 
Update to version 1.2.0

v1.2.0 - 2020-07-05
===================

Added
-----

* Bootstrap 4 templates
* Support for Django 2.2 and 3.0

Fixes
-----

* Replace calls to add_description_unit. As of Sphinx 2.4, the deprecated
  add_description_unit function has been removed.
* Fix CRYPT-DES hash method for LDAP
* Fix various spelling miskate in README.rst
* Service URL: keep blank GET arguments

Changed
-------

* Use python3 for flake8, check_rst and coverage
* Update README.rst quickstart for using python3 by default

Removed
-------

* Drop support for Django 2.0 and 2.1 as it reached end of life.
  We still keep Django 1.11 as it is the last supported release
  by python2 AND the currently packaged version of Django in
  Debian Buster (current stable).
This commit is contained in:
Valentin Samir 2020-07-05 15:41:04 +02:00 committed by GitHub
commit f15d0fa448
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
34 changed files with 537 additions and 162 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.travis.yml
View File

@ -1,9 +1,9 @@
language: python language: python
matrix: matrix:
include: include:
- python: "2.7" - python: "3.8"
env: TOX_ENV=flake8 env: TOX_ENV=flake8
- python: "2.7" - python: "3.8"
env: TOX_ENV=check_rst env: TOX_ENV=check_rst
- python: "2.7" - python: "2.7"
env: TOX_ENV=py27-django111 env: TOX_ENV=py27-django111
@ -19,7 +19,13 @@ matrix:
env: TOX_ENV=py35-django21 env: TOX_ENV=py35-django21
- python: "3.6" - python: "3.6"
env: TOX_ENV=py36-django21 env: TOX_ENV=py36-django21
- python: "2.7" - python: "3.7"
env: TOX_ENV=py37-django22
- python: "3.8"
env: TOX_ENV=py38-django22
- python: "3.8"
env: TOX_ENV=py38-django30
- python: "3.8"
env: TOX_ENV=coverage env: TOX_ENV=coverage
cache: cache:
directories: directories:

10
.update_coverage
View File

@ -1,5 +1,7 @@
#!/bin/bash #!/bin/bash
BASEDIR="$1" set -x
set -e
BASEDIR="$(realpath "$1")"
PROJECT_NAME="$2" PROJECT_NAME="$2"
TITLE="Coverage report of $PROJECT_NAME" TITLE="Coverage report of $PROJECT_NAME"
@ -31,7 +33,7 @@ fi
VENV="$(mktemp -d)" VENV="$(mktemp -d)"
HTMLREPORT="$(mktemp -d)" HTMLREPORT="$(mktemp -d)"
virtualenv "$VENV" virtualenv -p python3 "$VENV"
"$VENV/bin/pip" install coverage "$VENV/bin/pip" install coverage
"$VENV/bin/coverage" html --title "$TITLE" --directory "$HTMLREPORT" "$VENV/bin/coverage" html --title "$TITLE" --directory "$HTMLREPORT"
rm -rf "$VENV" rm -rf "$VENV"
@ -43,12 +45,14 @@ cd "$BASEDIR"
rm -rf "$HTMLREPORT" rm -rf "$HTMLREPORT"
set +x
echo "curl https://badges.genua.fr/coverage/ ..."
curl https://badges.genua.fr/coverage/ \ curl https://badges.genua.fr/coverage/ \
-F "secret=$COVERAGE_TOKEN" \ -F "secret=$COVERAGE_TOKEN" \
-F "tar=@$BASEDIR/coverage.tar.gz" \ -F "tar=@$BASEDIR/coverage.tar.gz" \
-F "project=$PROJECT_NAME" \ -F "project=$PROJECT_NAME" \
-F "branch=$BRANCH" -F "branch=$BRANCH"
set -x
rm "$BASEDIR/coverage.tar.gz" rm "$BASEDIR/coverage.tar.gz"

32
CHANGELOG.rst
View File

@ -6,6 +6,38 @@ All notable changes to this project will be documented in this file.
.. contents:: Table of Contents .. contents:: Table of Contents
:depth: 2 :depth: 2
v1.2.0 - 2020-07-05
===================
Added
-----
* Bootstrap 4 templates
* Support for Django 2.2 and 3.0
Fixes
-----
* Replace calls to add_description_unit. As of Sphinx 2.4, the deprecated
add_description_unit function has been removed.
* Fix CRYPT-DES hash method for LDAP
* Fix various spelling miskate in README.rst
* Service URL: keep blank GET arguments
Changed
-------
* Use python3 for flake8, check_rst and coverage
* Update README.rst quickstart for using python3 by default
Removed
-------
* Drop support for Django 2.0 and 2.1 as it reached end of life.
We still keep Django 1.11 as it is the last supported release
by python2 AND the currently packaged version of Django in
Debian Buster (current stable).
v1.1.0 - 2019-03-02 v1.1.0 - 2019-03-02
=================== ===================

237
README.rst
View File

@ -6,8 +6,8 @@ CAS Server
CAS Server is a Django application implementing the `CAS Protocol 3.0 Specification CAS Server is a Django application implementing the `CAS Protocol 3.0 Specification
<https://apereo.github.io/cas/4.2.x/protocol/CAS-Protocol-Specification.html>`_. <https://apereo.github.io/cas/4.2.x/protocol/CAS-Protocol-Specification.html>`_.
By default, the authentication process use django internal users but you can easily By default, the authentication process uses django internal users but you can easily
use any sources (see the `Authentication backend`_ section and auth classes in the auth.py file) use any source (see the `Authentication backend`_ section and auth classes in the auth.py file)
.. contents:: Table of Contents .. contents:: Table of Contents
@ -16,12 +16,12 @@ Features
* Support CAS version 1.0, 2.0, 3.0 * Support CAS version 1.0, 2.0, 3.0
* Support Single Sign Out * Support Single Sign Out
* Configuration of services via the django Admin application * Configuration of services via the Django Admin application
* Fine control on which user's attributes are passed to which service * Fine control on which user's attributes are passed to which service
* Possibility to rename/rewrite attributes per service * Possibility to rename/rewrite attributes per service
* Possibility to require some attribute values per service * Possibility to require some attribute values per service
* Federated mode between multiple CAS * Federated mode between multiple CAS
* Supports Django 1.11 and 2.0 * Supports Django 1.11, 2.2 and 3.0
* Supports Python 2.7, 3.5+ * Supports Python 2.7, 3.5+
Dependencies Dependencies
@ -29,16 +29,16 @@ Dependencies
``django-cas-server`` depends on the following python packages: ``django-cas-server`` depends on the following python packages:
* Django >= 1.11 < 2.1 * Django >= 1.11 < 3.1
* requests >= 2.4 * requests >= 2.4
* requests_futures >= 0.9.5 * requests_futures >= 0.9.5
* lxml >= 3.4 * lxml >= 3.4
* six >= 1.8 * six >= 1.8
Minimal version of packages dependancy are just indicative and meens that ``django-cas-server`` has Minimal version of package dependencies are just indicative and means that ``django-cas-server`` has
been tested with it. Previous versions of dependencies may or may not work. been tested with it. Previous versions of dependencies may or may not work.
Additionally, denpending of the `Authentication backend`_ you plan to use, you may need the following Additionally, depending on the `Authentication backend`_ you plan to use, you may need the following
python packages: python packages:
* ldap3 * ldap3
@ -46,32 +46,32 @@ python packages:
* mysql-python * mysql-python
Here there is a table with the name of python packages and the corresponding packages providing Here is a table with the name of python packages and the corresponding packages providing
them on debian like systems and centos like systems. them on debian like systems and centos like systems.
You should try as much as possible to use system packages as there are automatically updated then You should try as much as possible to use system packages as they are automatically updated when
you update your system. You can then install Not Available (N/A) you update your system. You can then install Not Available (N/A)
packages on your system using pip inside a virtualenv as described in the `Installation`_ section. packages on your system using pip3 inside a virtualenv as described in the `Installation`_ section.
For use with python3, just replace python(2) in the table by python3. For use with python2, just replace python3(6) in the table by python.
+------------------+-------------------------+---------------------+ +------------------+--------------------------+---------------------+
| python package | debian like systems | centos like systems | | python package | debian like systems | centos like systems |
+==================+=========================+=====================+ +==================+==========================+=====================+
| Django | python-django | python-django | | Django | python3-django | python36-django |
+------------------+-------------------------+---------------------+ +------------------+--------------------------+---------------------+
| requests | python-requests | python-requests | | requests | python3-requests | python36-requests |
+------------------+-------------------------+---------------------+ +------------------+--------------------------+---------------------+
| requests_futures | python-requests-futures | N/A | | requests_futures | python3-requests-futures | N/A |
+------------------+-------------------------+---------------------+ +------------------+--------------------------+---------------------+
| lxml | python-lxml | python-lxml | | lxml | python3-lxml | python36-lxml |
+------------------+-------------------------+---------------------+ +------------------+--------------------------+---------------------+
| six | python-six | python-six | | six | python3-six | python36-six |
+------------------+-------------------------+---------------------+ +------------------+--------------------------+---------------------+
| ldap3 | python-ldap3 | python-ldap3 | | ldap3 | python3-ldap3 | python36-ldap3 |
+------------------+-------------------------+---------------------+ +------------------+--------------------------+---------------------+
| psycopg2 | python-psycopg2 | python-psycopg2 | | psycopg2 | python3-psycopg2 | python36-psycopg2 |
+------------------+-------------------------+---------------------+ +------------------+--------------------------+---------------------+
| mysql-python | python-mysqldb | python2-mysql | | mysql-python | python3-mysqldb | python36-mysql |
+------------------+-------------------------+---------------------+ +------------------+--------------------------+---------------------+
Installation Installation
============ ============
@ -84,23 +84,18 @@ The recommended installation mode is to use a virtualenv with ``--system-site-pa
On debian like systems:: On debian like systems::
$ sudo apt-get install python-django python-requests python-six python-lxml python-requests-futures $ sudo apt-get install python3-django python3-requests python3-six python3-lxml python3-requests-futures
On debian jessie, you can use the version of python-django available in the On debian jessie, you can use the version of python-django available in the
`backports <https://backports.debian.org/Instructions/>`_. `backports <https://backports.debian.org/Instructions/>`_.
On centos like systems:: On centos like systems with epel enabled::
$ sudo yum install python-django python-requests python-six python-lxml $ sudo yum install python36-django python36-requests python36-six python36-lxml
3. Create a virtualenv:: 3. Create a virtualenv::
$ virtualenv --system-site-packages cas_venv $ virtualenv -p python3 --system-site-packages cas_venv
Running virtualenv with interpreter /var/www/html/cas-server/bin/python2
Using real prefix '/usr'
New python executable in cas/bin/python2
Also creating executable in cas/bin/python
Installing setuptools, pip...done.
4. And `activate it <https://virtualenv.pypa.io/en/stable/userguide/#activate-script>`__:: 4. And `activate it <https://virtualenv.pypa.io/en/stable/userguide/#activate-script>`__::
@ -126,7 +121,7 @@ The recommended installation mode is to use a virtualenv with ``--system-site-pa
`PYTHONPATH <https://docs.python.org/2/using/cmdline.html#envvar-PYTHONPATH>`_ `PYTHONPATH <https://docs.python.org/2/using/cmdline.html#envvar-PYTHONPATH>`_
(for instance by symlinking ``cas_server`` to the root of your django project). (for instance by symlinking ``cas_server`` to the root of your django project).
7. Open ``cas_project/settings.py`` in you favourite editor and follow the quick start section. 7. Open ``cas_project/settings.py`` in your favourite editor and follow the quick start section.
Quick start Quick start
@ -166,15 +161,15 @@ Quick start
``cas_clean_tickets`` and ``cas_clean_sessions``. ``cas_clean_tickets`` and ``cas_clean_sessions``.
* ``clearsessions``: please see `Clearing the session store <https://docs.djangoproject.com/en/stable/topics/http/sessions/#clearing-the-session-store>`_. * ``clearsessions``: please see `Clearing the session store <https://docs.djangoproject.com/en/stable/topics/http/sessions/#clearing-the-session-store>`_.
* ``cas_clean_tickets``: old tickets and timed-out tickets do not get purge from * ``cas_clean_tickets``: old tickets and timed-out tickets do not get purged from
the database automatically. They are just marked as invalid. ``cas_clean_tickets`` the database automatically. They are just marked as invalid. ``cas_clean_tickets``
is a clean-up management command for this purpose. It send SingleLogOut request is a clean-up management command for this purpose. It sends SingleLogOut requests
to services with timed out tickets and delete them. to services with timed out tickets and deletes them.
* ``cas_clean_sessions``: Logout and purge users (sending SLO requests) that are * ``cas_clean_sessions``: Logout and purge users (sending SLO requests) that are
inactive since more than ``SESSION_COOKIE_AGE``. The default value for is ``1209600`` inactive more than ``SESSION_COOKIE_AGE``. The default value is ``1209600``
seconds (2 weeks). You probably should reduce it to something like ``86400`` seconds (1 day). seconds (2 weeks). You probably should reduce it to something like ``86400`` seconds (1 day).
You could for example do as bellow:: You could, for example, do as below::
0 0 * * * cas-user /path/to/project/manage.py clearsessions 0 0 * * * cas-user /path/to/project/manage.py clearsessions
*/5 * * * * cas-user /path/to/project/manage.py cas_clean_tickets */5 * * * * cas-user /path/to/project/manage.py cas_clean_tickets
@ -184,7 +179,7 @@ Quick start
6. Start the development server and visit http://127.0.0.1:8000/admin/ 6. Start the development server and visit http://127.0.0.1:8000/admin/
to add a first service allowed to authenticate user against the CAS to add a first service allowed to authenticate user against the CAS
(you'll need the Admin app enabled). See the `Service Patterns`_ section bellow. (you'll need the Admin app enabled). See the `Service Patterns`_ section below.
7. Visit http://127.0.0.1:8000/cas/ to login with your django users. 7. Visit http://127.0.0.1:8000/cas/ to login with your django users.
@ -200,34 +195,37 @@ All settings are optional. Add them to ``settings.py`` to customize ``django-cas
Template settings Template settings
----------------- -----------------
* ``CAS_LOGO_URL``: URL to the logo showed in the up left corner on the default * ``CAS_LOGO_URL``: URL to the logo shown in the upper left corner on the default
templates. Set it to ``False`` to disable it. template. Set it to ``False`` to disable it.
* ``CAS_FAVICON_URL``: URL to the favicon (shortcut icon) used by the default templates. * ``CAS_FAVICON_URL``: URL to the favicon (shortcut icon) used by the default templates.
Default is a key icon. Set it to ``False`` to disable it. Default is a key icon. Set it to ``False`` to disable it.
* ``CAS_SHOW_POWERED``: Set it to ``False`` to hide the powered by footer. The default is ``True``. * ``CAS_SHOW_POWERED``: Set it to ``False`` to hide the powered by footer. The default is ``True``.
* ``CAS_COMPONENT_URLS``: URLs to css and javascript external components. It is a dictionnary * ``CAS_COMPONENT_URLS``: URLs to css and javascript external components. It is a dictionary
having the five following keys: ``"bootstrap3_css"``, ``"bootstrap3_js"``, having the five following keys: ``"bootstrap3_css"``, ``"bootstrap3_js"``,
``"html5shiv"``, ``"respond"``, ``"jquery"``. The default is:: ``bootstrap4_css``, ``bootstrap4_js``, ``"html5shiv"``, ``"respond"``, ``"jquery"``.
The default is::
{ {
"bootstrap3_css": "//maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css", "bootstrap3_css": "//maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css",
"bootstrap3_js": "//maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js", "bootstrap3_js": "//maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js",
"html5shiv": "//oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js", "html5shiv": "//oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js",
"respond": "//oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js", "respond": "//oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js",
"bootstrap4_css": "//stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css",
"bootstrap4_js": "//stackpath.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js",
"jquery": "//code.jquery.com/jquery.min.js", "jquery": "//code.jquery.com/jquery.min.js",
} }
if you omit some keys of the dictionnary, the default value for these keys is used. if you omit some keys of the dictionary, the default value for these keys is used.
* ``CAS_SHOW_SERVICE_MESSAGES``: Messages displayed about the state of the service on the login page. * ``CAS_SHOW_SERVICE_MESSAGES``: Messages displayed about the state of the service on the login page.
The default is ``True``. The default is ``True``.
* ``CAS_INFO_MESSAGES``: Messages displayed in info-boxes on the html pages of the default templates. * ``CAS_INFO_MESSAGES``: Messages displayed in info-boxes on the html pages of the default templates.
It is a dictionnary mapping message name to a message dict. A message dict has 3 keys: It is a dictionary mapping message name to a message dict. A message dict has 3 keys:
* ``message``: A unicode message to display, potentially wrapped around ugettex_lazy * ``message``: A unicode message to display, potentially wrapped around ugettex_lazy
* ``discardable``: A boolean, specify if the users can close the message info-box * ``discardable``: A boolean, specify if the users can close the message info-box
* ``type``: One of info, success, info, warning, danger. The type of the info-box. * ``type``: One of info, success, warning, danger. The type of the info-box.
``CAS_INFO_MESSAGES`` contains by default one message, ``cas_explained``, which explain ``CAS_INFO_MESSAGES`` contains by default one message, ``cas_explained``, which explains
roughly the purpose of a CAS. The default is:: roughly the purpose of a CAS. The default is::
{ {
@ -238,24 +236,26 @@ Template settings
u"your session expires or you logout." u"your session expires or you logout."
), ),
"discardable": True, "discardable": True,
"type": "info", # one of info, success, info, warning, danger "type": "info", # one of info, success, warning, danger
}, },
} }
* ``CAS_INFO_MESSAGES_ORDER``: A list of message names. Order in which info-box messages are * ``CAS_INFO_MESSAGES_ORDER``: A list of message names. Order in which info-box messages are
displayed. Use an empty list to disable messages display. The default is ``[]``. displayed. Use an empty list to disable messages display. The default is ``[]``.
* ``CAS_LOGIN_TEMPLATE``: Path to the template showed on ``/login`` then the user * ``CAS_LOGIN_TEMPLATE``: Path to the template shown on ``/login`` when the user
is not autenticated. The default is ``"cas_server/login.html"``. is not autenticated. The default is ``"cas_server/bs4/login.html"``.
* ``CAS_WARN_TEMPLATE``: Path to the template showed on ``/login?service=...`` then * ``CAS_WARN_TEMPLATE``: Path to the template shown on ``/login?service=...`` when
the user is authenticated and has asked to be warned before being connected the user is authenticated and has asked to be warned before being connected
to a service. The default is ``"cas_server/warn.html"``. to a service. The default is ``"cas_server/bs4/warn.html"``.
* ``CAS_LOGGED_TEMPLATE``: Path to the template showed on ``/login`` then to user is * ``CAS_LOGGED_TEMPLATE``: Path to the template shown on ``/login`` when the user is
authenticated. The default is ``"cas_server/logged.html"``. authenticated. The default is ``"cas_server/bs4/logged.html"``.
* ``CAS_LOGOUT_TEMPLATE``: Path to the template showed on ``/logout`` then to user * ``CAS_LOGOUT_TEMPLATE``: Path to the template shown on ``/logout`` when the user
is being disconnected. The default is ``"cas_server/logout.html"`` is being disconnected. The default is ``"cas_server/bs4/logout.html"``
* ``CAS_REDIRECT_TO_LOGIN_AFTER_LOGOUT``: Should we redirect users to ``/login`` after they * ``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``. logged out instead of displaying ``CAS_LOGOUT_TEMPLATE``. The default is ``False``.
Note that the old bootstrap3 template is available in ``cas_server/bs3/``
Authentication settings Authentication settings
----------------------- -----------------------
@ -265,23 +265,24 @@ Authentication settings
Available classes bundled with ``django-cas-server`` are listed below in the Available classes bundled with ``django-cas-server`` are listed below in the
`Authentication backend`_ section. `Authentication backend`_ section.
* ``SESSION_COOKIE_AGE``: This is a django settings. Here, it control the delay in seconds after * ``SESSION_COOKIE_AGE``: This is a django setting. Here, it controls the delay in seconds after
which inactive users are logged out. The default is ``1209600`` (2 weeks). You probably should which inactive users are logged out. The default is ``1209600`` (2 weeks). You probably should
reduce it to something like ``86400`` seconds (1 day). reduce it to something like ``86400`` seconds (1 day).
* ``CAS_TGT_VALIDITY``: Max time after with the user MUST reauthenticate. Let it to `None` for no * ``CAS_TGT_VALIDITY``: Max time after which the user MUST reauthenticate. Set it to `None` for no
max time.This can be used to force refreshing cached informations only available upon user max time. This can be used to force refreshing cached information only available upon user
authentication like the user attributes in federation mode or with the ldap auth in bind mode. authentication like the user attributes in federation mode or with the ldap auth in bind mode.
The default is ``None``. The default is ``None``.
* ``CAS_PROXY_CA_CERTIFICATE_PATH``: Path to certificate authorities file. Usually on linux * ``CAS_PROXY_CA_CERTIFICATE_PATH``: Path to certificate authorities file. Usually on linux
the local CAs are in ``/etc/ssl/certs/ca-certificates.crt``. The default is ``True`` which 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 tells requests to use its internal certificate authorities. Setting it to ``False`` should
disable all x509 certificates validation and MUST not be done in production. disable all x509 certificate validation and MUST not be done in production.
x509 certificate validation is perform upon PGT issuance. x509 certificate validation is performed upon PGT issuance.
* ``CAS_SLO_MAX_PARALLEL_REQUESTS``: Maximum number of parallel single log out requests sent.
If more requests need to be sent, they 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``.
* ``CAS_SLO_TIMEOUT``: Timeout for a single SLO request in seconds. The default is ``5``. * ``CAS_SLO_TIMEOUT``: Timeout for a single SLO request in seconds. The default is ``5``.
@ -290,7 +291,7 @@ Federation settings
* ``CAS_FEDERATE``: A boolean for activating the federated mode (see the `Federation mode`_ * ``CAS_FEDERATE``: A boolean for activating the federated mode (see the `Federation mode`_
section below). The default is ``False``. section below). The default is ``False``.
* ``CAS_FEDERATE_REMEMBER_TIMEOUT``: Time after witch the cookie use for "remember my identity * ``CAS_FEDERATE_REMEMBER_TIMEOUT``: Time after which the cookie used for "remember my identity
provider" expire. The default is ``604800``, one week. The cookie is called provider" expire. The default is ``604800``, one week. The cookie is called
``_remember_provider``. ``_remember_provider``.
@ -298,7 +299,7 @@ Federation settings
New version warnings settings New version warnings settings
----------------------------- -----------------------------
* ``CAS_NEW_VERSION_HTML_WARNING``: A boolean for diplaying a warning on html pages then a new * ``CAS_NEW_VERSION_HTML_WARNING``: A boolean for diplaying a warning on html pages that a new
version of the application is avaible. Once closed by a user, it is not displayed to this user version of the application is avaible. Once closed by a user, it is not displayed to this user
until the next new version. The default is ``True``. until the next new version. The default is ``True``.
* ``CAS_NEW_VERSION_EMAIL_WARNING``: A boolean for sending a email to ``settings.ADMINS`` when a new * ``CAS_NEW_VERSION_EMAIL_WARNING``: A boolean for sending a email to ``settings.ADMINS`` when a new
@ -319,22 +320,22 @@ Tickets validity settings
Tickets miscellaneous settings Tickets miscellaneous settings
------------------------------ ------------------------------
* ``CAS_TICKET_LEN``: Default ticket length. All CAS implementation MUST support ST and PT * ``CAS_TICKET_LEN``: Default ticket length. All CAS implementations MUST support ST and PT
up to 32 chars, PGT and PGTIOU up to 64 chars and it is RECOMMENDED that all tickets up 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``. to 256 chars are supported. Here the default is ``64``.
* ``CAS_LT_LEN``: Length of the login tickets. Login tickets are only processed by ``django-cas-server`` * ``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``. thus there are no length restrictions on it. The default is ``CAS_TICKET_LEN``.
* ``CAS_ST_LEN``: Length of the service tickets. 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. You may need to lower it to ``32`` if you use some old clients.
* ``CAS_PT_LEN``: Length of the proxy tickets. The default is ``CAS_TICKET_LEN``. * ``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`` This length should be the same as ``CAS_ST_LEN``. You may need to lower it to ``32``
if you use some old clients. if you use some old clients.
* ``CAS_PGT_LEN``: Length of the proxy granting tickets. The default is ``CAS_TICKET_LEN``. * ``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_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_LOGIN_TICKET_PREFIX``: Prefix of login tickets. The default is ``"LT"``.
* ``CAS_SERVICE_TICKET_PREFIX``: Prefix of service tickets. The default is ``"ST"``. * ``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 The CAS specification mandates that service tickets MUST begin with the characters ST
so you should not change this. so you should not change this.
* ``CAS_PROXY_TICKET_PREFIX``: Prefix of proxy ticket. The default is ``"PT"``. * ``CAS_PROXY_TICKET_PREFIX``: Prefix of proxy ticket. The default is ``"PT"``.
* ``CAS_PROXY_GRANTING_TICKET_PREFIX``: Prefix of proxy granting ticket. The default is ``"PGT"``. * ``CAS_PROXY_GRANTING_TICKET_PREFIX``: Prefix of proxy granting ticket. The default is ``"PGT"``.
@ -344,7 +345,7 @@ Tickets miscellaneous settings
Mysql backend settings Mysql backend settings
---------------------- ----------------------
Deprecated, see the `Sql backend settings`_. Deprecated, see the `Sql backend settings`_.
Only usefull if you are using the mysql authentication backend: Only useful if you are using the mysql authentication backend:
* ``CAS_SQL_HOST``: Host for the SQL server. The default is ``"localhost"``. * ``CAS_SQL_HOST``: Host for the SQL server. The default is ``"localhost"``.
* ``CAS_SQL_USERNAME``: Username for connecting to the SQL server. * ``CAS_SQL_USERNAME``: Username for connecting to the SQL server.
@ -358,12 +359,12 @@ Only usefull if you are using the mysql authentication backend:
* ``CAS_SQL_PASSWORD_CHECK``: The method used to check the user password. Must be one of the following: * ``CAS_SQL_PASSWORD_CHECK``: The method used to check the user password. Must be one of the following:
* ``"crypt"`` (see <https://en.wikipedia.org/wiki/Crypt_(C)>), the password in the database * ``"crypt"`` (see <https://en.wikipedia.org/wiki/Crypt_(C)>), the password in the database
should begin this $ should begin with $
* ``"ldap"`` (see https://tools.ietf.org/id/draft-stroeder-hashed-userpassword-values-01.html) * ``"ldap"`` (see https://tools.ietf.org/id/draft-stroeder-hashed-userpassword-values-01.html)
the password in the database must begin with one of {MD5}, {SMD5}, {SHA}, {SSHA}, {SHA256}, the password in the database must begin with one of {MD5}, {SMD5}, {SHA}, {SSHA}, {SHA256},
{SSHA256}, {SHA384}, {SSHA384}, {SHA512}, {SSHA512}, {CRYPT}. {SSHA256}, {SHA384}, {SSHA384}, {SHA512}, {SSHA512}, {CRYPT}.
* ``"hex_HASH_NAME"`` with ``HASH_NAME`` in md5, sha1, sha224, sha256, sha384, sha512. * ``"hex_HASH_NAME"`` with ``HASH_NAME`` in md5, sha1, sha224, sha256, sha384, sha512.
The hashed password in the database is compare to the hexadecimal digest of the clear The hashed password in the database is compared to the hexadecimal digest of the clear
password hashed with the corresponding algorithm. password hashed with the corresponding algorithm.
* ``"plain"``, the password in the database must be in clear. * ``"plain"``, the password in the database must be in clear.
@ -372,10 +373,10 @@ Only usefull if you are using the mysql authentication backend:
Sql backend settings Sql backend settings
-------------------- --------------------
Only usefull if you are using the sql authentication backend. You must add a ``"cas_server"`` Only useful if you are using the sql authentication backend. You must add a ``"cas_server"``
database to `settings.DATABASES <https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-DATABASES>`__ database to `settings.DATABASES <https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-DATABASES>`__
as defined in the django documentation. It is then the database as defined in the django documentation. It is then the database
use by the sql backend. used by the sql backend.
* ``CAS_SQL_USER_QUERY``: The query performed upon user authentication. * ``CAS_SQL_USER_QUERY``: The query performed upon user authentication.
The username must be in field ``username``, the password in ``password``, The username must be in field ``username``, the password in ``password``,
@ -384,61 +385,61 @@ use by the sql backend.
* ``CAS_SQL_PASSWORD_CHECK``: The method used to check the user password. Must be one of the following: * ``CAS_SQL_PASSWORD_CHECK``: The method used to check the user password. Must be one of the following:
* ``"crypt"`` (see <https://en.wikipedia.org/wiki/Crypt_(C)>), the password in the database * ``"crypt"`` (see <https://en.wikipedia.org/wiki/Crypt_(C)>), the password in the database
should begin this $ should begin with $
* ``"ldap"`` (see https://tools.ietf.org/id/draft-stroeder-hashed-userpassword-values-01.html) * ``"ldap"`` (see https://tools.ietf.org/id/draft-stroeder-hashed-userpassword-values-01.html)
the password in the database must begin with one of {MD5}, {SMD5}, {SHA}, {SSHA}, {SHA256}, the password in the database must begin with one of {MD5}, {SMD5}, {SHA}, {SSHA}, {SHA256},
{SSHA256}, {SHA384}, {SSHA384}, {SHA512}, {SSHA512}, {CRYPT}. {SSHA256}, {SHA384}, {SSHA384}, {SHA512}, {SSHA512}, {CRYPT}.
* ``"hex_HASH_NAME"`` with ``HASH_NAME`` in md5, sha1, sha224, sha256, sha384, sha512. * ``"hex_HASH_NAME"`` with ``HASH_NAME`` in md5, sha1, sha224, sha256, sha384, sha512.
The hashed password in the database is compare to the hexadecimal digest of the clear The hashed password in the database is compared to the hexadecimal digest of the clear
password hashed with the corresponding algorithm. password hashed with the corresponding algorithm.
* ``"plain"``, the password in the database must be in clear. * ``"plain"``, the password in the database must be in clear.
The default is ``"crypt"``. The default is ``"crypt"``.
* ``CAS_SQL_PASSWORD_CHARSET``: Charset the SQL users passwords was hash with. This is needed to * ``CAS_SQL_PASSWORD_CHARSET``: Charset the SQL users passwords was hash with. This is needed to
encode the user sended password before hashing it for comparison. The default is ``"utf-8"``. encode the user submitted password before hashing it for comparison. The default is ``"utf-8"``.
Ldap backend settings Ldap backend settings
--------------------- ---------------------
Only usefull if you are using the ldap authentication backend: Only useful if you are using the ldap authentication backend:
* ``CAS_LDAP_SERVER``: Address of the LDAP server. The default is ``"localhost"``. * ``CAS_LDAP_SERVER``: Address of the LDAP server. The default is ``"localhost"``.
* ``CAS_LDAP_USER``: User bind address, for example ``"cn=admin,dc=crans,dc=org"`` for * ``CAS_LDAP_USER``: User bind address, for example ``"cn=admin,dc=crans,dc=org"`` for
connecting to the LDAP server. connecting to the LDAP server.
* ``CAS_LDAP_PASSWORD``: Password for connecting to the LDAP server. * ``CAS_LDAP_PASSWORD``: Password for connecting to the LDAP server.
* ``CAS_LDAP_BASE_DN``: LDAP search base DN, for example ``"ou=data,dc=crans,dc=org"``. * ``CAS_LDAP_BASE_DN``: LDAP search base DN, for example ``"ou=data,dc=crans,dc=org"``.
* ``CAS_LDAP_USER_QUERY``: Search filter for searching user by username. User inputed usernames are * ``CAS_LDAP_USER_QUERY``: Search filter for searching user by username. User entered usernames are
escaped using ``ldap3.utils.conv.escape_bytes``. The default is ``"(uid=%s)"`` escaped using ``ldap3.utils.conv.escape_bytes``. The default is ``"(uid=%s)"``
* ``CAS_LDAP_USERNAME_ATTR``: Attribute used for users usernames. The default is ``"uid"`` * ``CAS_LDAP_USERNAME_ATTR``: Attribute used for user's usernames. The default is ``"uid"``
* ``CAS_LDAP_PASSWORD_ATTR``: Attribute used for users passwords. The default is ``"userPassword"`` * ``CAS_LDAP_PASSWORD_ATTR``: Attribute used for user's passwords. The default is ``"userPassword"``
* ``CAS_LDAP_PASSWORD_CHECK``: The method used to check the user password. Must be one of the following: * ``CAS_LDAP_PASSWORD_CHECK``: The method used to check the user password. Must be one of the following:
* ``"crypt"`` (see <https://en.wikipedia.org/wiki/Crypt_(C)>), the password in the database * ``"crypt"`` (see <https://en.wikipedia.org/wiki/Crypt_(C)>), the password in the database
should begin this $ should begin with $
* ``"ldap"`` (see https://tools.ietf.org/id/draft-stroeder-hashed-userpassword-values-01.html) * ``"ldap"`` (see https://tools.ietf.org/id/draft-stroeder-hashed-userpassword-values-01.html)
the password in the database must begin with one of {MD5}, {SMD5}, {SHA}, {SSHA}, {SHA256}, the password in the database must begin with one of {MD5}, {SMD5}, {SHA}, {SSHA}, {SHA256},
{SSHA256}, {SHA384}, {SSHA384}, {SHA512}, {SSHA512}, {CRYPT}. {SSHA256}, {SHA384}, {SSHA384}, {SHA512}, {SSHA512}, {CRYPT}.
* ``"hex_HASH_NAME"`` with ``HASH_NAME`` in md5, sha1, sha224, sha256, sha384, sha512. * ``"hex_HASH_NAME"`` with ``HASH_NAME`` in md5, sha1, sha224, sha256, sha384, sha512.
The hashed password in the database is compare to the hexadecimal digest of the clear The hashed password in the database is compared to the hexadecimal digest of the clear
password hashed with the corresponding algorithm. password hashed with the corresponding algorithm.
* ``"plain"``, the password in the database must be in clear. * ``"plain"``, the password in the database must be in clear.
* ``"bind``, the user credentials are used to bind to the ldap database and retreive the user * ``"bind``, the user credentials are used to bind to the ldap database and retreive the user
attribute. In this mode, the settings ``CAS_LDAP_PASSWORD_ATTR`` and ``CAS_LDAP_PASSWORD_CHARSET`` attribute. In this mode, the settings ``CAS_LDAP_PASSWORD_ATTR`` and ``CAS_LDAP_PASSWORD_CHARSET``
are ignored, and it is the ldap server that perform password check. The counterpart is that are ignored, and it is the ldap server that performs the password check. The counterpart is that
the user attributes are only available upon user password check and so are cached for later the user attributes are only available upon user password check and so are cached for later
use. All the other modes directly fetch the user attributes from the database whenever there use. All the other modes directly fetch the user attributes from the database whenever they
are needed. This mean that is you use this mode, they can be some difference between the are needed. This mean that is you use this mode, there can be some differences between the
attributes in database and the cached ones if changes happend in the database after the user attributes in database and the cached ones if changes happen in the database after the user
authentiate. See the parameter ``CAS_TGT_VALIDITY`` to force user to reauthenticate periodically. authentiates. See the parameter ``CAS_TGT_VALIDITY`` to force user to reauthenticate periodically.
The default is ``"ldap"``. The default is ``"ldap"``.
* ``CAS_LDAP_PASSWORD_CHARSET``: Charset the LDAP users passwords was hash with. This is needed to * ``CAS_LDAP_PASSWORD_CHARSET``: Charset the LDAP users passwords was hashed with. This is needed to
encode the user sended password before hashing it for comparison. The default is ``"utf-8"``. encode the user submitted password before hashing it for comparison. The default is ``"utf-8"``.
Test backend settings Test backend settings
--------------------- ---------------------
Only usefull if you are using the test authentication backend: Only useful if you are using the test authentication backend:
* ``CAS_TEST_USER``: Username of the test user. The default is ``"test"``. * ``CAS_TEST_USER``: Username of the test user. The default is ``"test"``.
* ``CAS_TEST_PASSWORD``: Password of the test user. The default is ``"test"``. * ``CAS_TEST_PASSWORD``: Password of the test user. The default is ``"test"``.
@ -452,19 +453,19 @@ Authentication backend
``django-cas-server`` comes with some authentication backends: ``django-cas-server`` comes with some authentication backends:
* dummy backend ``cas_server.auth.DummyAuthUser``: all authentication attempt fails. * dummy backend ``cas_server.auth.DummyAuthUser``: all authentication attempts fail.
* test backend ``cas_server.auth.TestAuthUser``: username, password and returned attributes * test backend ``cas_server.auth.TestAuthUser``: username, password and returned attributes
for the user are defined by the ``CAS_TEST_*`` settings. for the user are defined by the ``CAS_TEST_*`` settings.
* django backend ``cas_server.auth.DjangoAuthUser``: Users are authenticated against django users system. * django backend ``cas_server.auth.DjangoAuthUser``: Users are authenticated against django users system.
This is the default backend. The returned attributes are the fields available on the user model. This is the default backend. The returned attributes are the fields available on the user model.
* mysql backend ``cas_server.auth.MysqlAuthUser``: Deprecated, use the sql backend instead. * mysql backend ``cas_server.auth.MysqlAuthUser``: Deprecated, use the sql backend instead.
see the `Mysql backend settings`_ section. The returned attributes are those return by sql query see the `Mysql backend settings`_ section. The returned attributes are those returned by sql query
``CAS_SQL_USER_QUERY``. ``CAS_SQL_USER_QUERY``.
* sql backend ``cas_server.auth.SqlAuthUser``: see the `Sql backend settings`_ section. * sql backend ``cas_server.auth.SqlAuthUser``: see the `Sql backend settings`_ section.
The returned attributes are those return by sql query ``CAS_SQL_USER_QUERY``. The returned attributes are those returned by sql query ``CAS_SQL_USER_QUERY``.
* ldap backend ``cas_server.auth.LdapAuthUser``: see the `Ldap backend settings`_ section. * ldap backend ``cas_server.auth.LdapAuthUser``: see the `Ldap backend settings`_ section.
The returned attributes are those of the ldap node returned by the query filter ``CAS_LDAP_USER_QUERY``. The returned attributes are those of the ldap node returned by the query filter ``CAS_LDAP_USER_QUERY``.
* federated backend ``cas_server.auth.CASFederateAuth``: It is automatically used then ``CAS_FEDERATE`` is ``True``. * federated backend ``cas_server.auth.CASFederateAuth``: It is automatically used when ``CAS_FEDERATE`` is ``True``.
You should not set it manually without setting ``CAS_FEDERATE`` to ``True``. You should not set it manually without setting ``CAS_FEDERATE`` to ``True``.
@ -542,7 +543,7 @@ Service Patterns
In a CAS context, ``Service`` refers to the application the client is trying to access. In a CAS context, ``Service`` refers to the application the client is trying to access.
By extension we use ``service`` for the URL of such an application. By extension we use ``service`` for the URL of such an application.
By default, ``django-cas-server`` do not allow any service to use the CAS to authenticate users. By default, ``django-cas-server`` does not allow any service to use the CAS to authenticate users.
In order to allow services, you need to connect to the django admin interface using a django In order to allow services, you need to connect to the django admin interface using a django
superuser, and add a first service pattern. superuser, and add a first service pattern.
@ -555,7 +556,7 @@ A service pattern comes with 9 fields:
* ``Pattern``: a regular expression used to match services. * ``Pattern``: a regular expression used to match services.
* ``User field``: the user attribute to use as username for services matching this service pattern. * ``User field``: the user attribute to use as username for services matching this service pattern.
Leave it empty to use the login name. Leave it empty to use the login name.
* ``Restrict username``: if checked, only login name defined below are allowed to get tickets * ``Restrict username``: if checked, only login names defined below are allowed to get tickets
for services matching this service pattern. for services matching this service pattern.
* ``Proxy``: if checked, allow the creation of Proxy Ticket for services matching this * ``Proxy``: if checked, allow the creation of Proxy Ticket for services matching this
service pattern. Otherwise, only Service Ticket will be created. service pattern. Otherwise, only Service Ticket will be created.
@ -564,25 +565,25 @@ A service pattern comes with 9 fields:
Hence you must only check this for trusted services that need it. (For instance, a webmail needs Hence you must only check this for trusted services that need it. (For instance, a webmail needs
Proxy Ticket to authenticate himself as the user to the imap server). Proxy Ticket to authenticate himself as the user to the imap server).
* ``Single log out``: Check it to send Single Log Out requests to authenticated services matching * ``Single log out``: Check it to send Single Log Out requests to authenticated services matching
this service pattern. SLO requests are send to all services the user is authenticated to then this service pattern. SLO requests are sent to all services the user is authenticated to when
the user disconnect. the user disconnects.
* ``Single log out callback``: The http(s) URL to POST the SLO requests. If empty, the service URL * ``Single log out callback``: The http(s) URL to POST the SLO requests. If empty, the service URL
is used. This field is useful to allow non http services (imap, smtp, ftp) to handle SLO requests. is used. This field is useful to allow non http services (imap, smtp, ftp) to handle SLO requests.
A service pattern has 4 associated models: A service pattern has 4 associated models:
* ``Usernames``: a list of username associated with the ``Restrict username`` field * ``Usernames``: a list of username associated with the ``Restrict username`` field
* ``Replace attribut names``: a list of user attributes to send to the service. Choose the name * ``Replace attribute names``: a list of user attributes to send to the service. Choose the name
used for sending the attribute by setting ``Remplacement`` or leave it empty to leave it unchanged. used for sending the attribute by setting ``Replacement`` or leave it empty to leave it unchanged.
* ``Replace attribut values``: a list of sent user attributes for which value needs to be tweak. * ``Replace attribute values``: a list of sent user attributes for which value needs to be tweaked.
Replace the attribute value by the string obtained by replacing the leftmost non-overlapping Replace the attribute value by the string obtained by replacing the leftmost non-overlapping
occurrences of ``pattern`` in string by ``replace``. In ``replace`` backslash escapes are processed. occurrences of ``pattern`` in string by ``replace``. In ``replace`` backslash escapes are processed.
Matched groups are captures by \1, \2, etc. Matched groups are captured by \1, \2, etc.
* ``Filter attribut values``: a list of user attributes for which value needs to match a regular * ``Filter attribute values``: a list of user attributes for which value needs to match a regular
expression. For instance, service A may need an email address, and you only want user with expression. For instance, service A may need an email address, and you only want user with
an email address to connect to it. To do so, put ``email`` in ``Attribute`` and ``.*`` in ``pattern``. an email address to connect to it. To do so, put ``email`` in ``Attribute`` and ``.*`` in ``pattern``.
Then a user ask a ticket for a service, the service URL is compare against each service patterns When a user asks for a ticket for a service, the service URL is compared against each service pattern
sorted by ``position``. The first service pattern that matches the service URL is chosen. sorted by ``position``. The first service pattern that matches the service URL is chosen.
Hence, you should give low ``position`` to very specific patterns like Hence, you should give low ``position`` to very specific patterns like
``^https://www\.example\.com(/.*)?$`` and higher ``position`` to generic patterns like ``^https://.*``. ``^https://www\.example\.com(/.*)?$`` and higher ``position`` to generic patterns like ``^https://.*``.
@ -593,9 +594,9 @@ So the service URL ``https://www.examle.com`` will use the service pattern for
Federation mode Federation mode
=============== ===============
``django-cas-server`` comes with a federation mode. Then ``CAS_FEDERATE`` is ``True``, ``django-cas-server`` comes with a federation mode. When ``CAS_FEDERATE`` is ``True``,
user are invited to choose an identity provider on the login page, then, they are redirected users are invited to choose an identity provider on the login page, then, they are redirected
to the provider CAS to authenticate. This provider transmit to ``django-cas-server`` the user to the provider CAS to authenticate. This provider transmits to ``django-cas-server`` the user
username and attributes. The user is now logged in on ``django-cas-server`` and can use username and attributes. The user is now logged in on ``django-cas-server`` and can use
services using ``django-cas-server`` as CAS. services using ``django-cas-server`` as CAS.
@ -635,7 +636,7 @@ Then using federate mode, you should add one command to a daily crontab: ``cas_c
This command clean the local cache of federated user from old unused users. This command clean the local cache of federated user from old unused users.
You could for example do as bellow:: You could for example do as below::
10 0 * * * cas-user /path/to/project/manage.py cas_clean_federate 10 0 * * * cas-user /path/to/project/manage.py cas_clean_federate

2
cas_server/__init__.py
View File

@ -11,7 +11,7 @@
"""A django CAS server application""" """A django CAS server application"""
#: version of the application #: version of the application
VERSION = '1.1.0' VERSION = '1.2.0'
#: path the the application configuration class #: path the the application configuration class
default_app_config = 'cas_server.apps.CasAppConfig' default_app_config = 'cas_server.apps.CasAppConfig'

7
cas_server/apps.py
View File

@ -9,9 +9,14 @@
# #
# (c) 2015-2016 Valentin Samir # (c) 2015-2016 Valentin Samir
"""django config module""" """django config module"""
from django.utils.translation import ugettext_lazy as _
from django.apps import AppConfig from django.apps import AppConfig
import sys
if sys.version_info < (3, ):
from django.utils.translation import ugettext_lazy as _
else:
from django.utils.translation import gettext_lazy as _
class CasAppConfig(AppConfig): class CasAppConfig(AppConfig):
""" """

17
cas_server/default_settings.py
View File

@ -12,10 +12,15 @@
"""Default values for the app's settings""" """Default values for the app's settings"""
from django.conf import settings from django.conf import settings
from django.templatetags.static import static from django.templatetags.static import static
from django.utils.translation import ugettext_lazy as _
from importlib import import_module from importlib import import_module
import sys
if sys.version_info < (3, ):
from django.utils.translation import ugettext_lazy as _
else:
from django.utils.translation import gettext_lazy as _
try: try:
#: URL to the logo showed in the up left corner on the default templates. #: URL to the logo showed in the up left corner on the default templates.
@ -39,17 +44,19 @@ CAS_COMPONENT_URLS = {
"bootstrap3_js": "//maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js", "bootstrap3_js": "//maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js",
"html5shiv": "//oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js", "html5shiv": "//oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js",
"respond": "//oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js", "respond": "//oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js",
"bootstrap4_css": "//stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css",
"bootstrap4_js": "//stackpath.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js",
"jquery": "//code.jquery.com/jquery.min.js", "jquery": "//code.jquery.com/jquery.min.js",
} }
#: Path to the template showed on /login then the user is not autenticated. #: Path to the template showed on /login then the user is not autenticated.
CAS_LOGIN_TEMPLATE = 'cas_server/login.html' CAS_LOGIN_TEMPLATE = 'cas_server/bs4/login.html'
#: Path to the template showed on /login?service=... then the user is authenticated and has asked #: Path to the template showed on /login?service=... then the user is authenticated and has asked
#: to be warned before being connected to a service. #: to be warned before being connected to a service.
CAS_WARN_TEMPLATE = 'cas_server/warn.html' CAS_WARN_TEMPLATE = 'cas_server/bs4/warn.html'
#: Path to the template showed on /login then to user is authenticated. #: Path to the template showed on /login then to user is authenticated.
CAS_LOGGED_TEMPLATE = 'cas_server/logged.html' CAS_LOGGED_TEMPLATE = 'cas_server/bs4/logged.html'
#: Path to the template showed on /logout then to user is being disconnected. #: Path to the template showed on /logout then to user is being disconnected.
CAS_LOGOUT_TEMPLATE = 'cas_server/logout.html' CAS_LOGOUT_TEMPLATE = 'cas_server/bs4/logout.html'
#: Should we redirect users to /login after they logged out instead of displaying #: Should we redirect users to /login after they logged out instead of displaying
#: :obj:`CAS_LOGOUT_TEMPLATE`. #: :obj:`CAS_LOGOUT_TEMPLATE`.
CAS_REDIRECT_TO_LOGIN_AFTER_LOGOUT = False CAS_REDIRECT_TO_LOGIN_AFTER_LOGOUT = False

7
cas_server/forms.py
View File

@ -13,11 +13,16 @@ from .default_settings import settings
from django import forms from django import forms
from django.forms import widgets from django.forms import widgets
from django.utils.translation import ugettext_lazy as _
import cas_server.utils as utils import cas_server.utils as utils
import cas_server.models as models import cas_server.models as models
import sys
if sys.version_info < (3, ):
from django.utils.translation import ugettext_lazy as _
else:
from django.utils.translation import gettext_lazy as _
class BootsrapForm(forms.Form): class BootsrapForm(forms.Form):
""" """

7
cas_server/management/commands/cas_clean_federate.py
View File

@ -10,10 +10,15 @@
# #
# (c) 2016 Valentin Samir # (c) 2016 Valentin Samir
from django.core.management.base import BaseCommand from django.core.management.base import BaseCommand
from django.utils.translation import ugettext_lazy as _
from ... import models from ... import models
import sys
if sys.version_info < (3, ):
from django.utils.translation import ugettext_lazy as _
else:
from django.utils.translation import gettext_lazy as _
class Command(BaseCommand): class Command(BaseCommand):
args = '' args = ''

7
cas_server/management/commands/cas_clean_sessions.py
View File

@ -11,10 +11,15 @@
# (c) 2016 Valentin Samir # (c) 2016 Valentin Samir
"""Clean deleted sessions management command""" """Clean deleted sessions management command"""
from django.core.management.base import BaseCommand from django.core.management.base import BaseCommand
from django.utils.translation import ugettext_lazy as _
from ... import models from ... import models
import sys
if sys.version_info < (3,):
from django.utils.translation import ugettext_lazy as _
else:
from django.utils.translation import gettext_lazy as _
class Command(BaseCommand): class Command(BaseCommand):
"""Clean deleted sessions""" """Clean deleted sessions"""

7
cas_server/management/commands/cas_clean_tickets.py
View File

@ -11,10 +11,15 @@
# (c) 2016 Valentin Samir # (c) 2016 Valentin Samir
"""Clean old trickets management command""" """Clean old trickets management command"""
from django.core.management.base import BaseCommand from django.core.management.base import BaseCommand
from django.utils.translation import ugettext_lazy as _
from ... import models from ... import models
import sys
if sys.version_info < (3, ):
from django.utils.translation import ugettext_lazy as _
else:
from django.utils.translation import gettext_lazy as _
class Command(BaseCommand): class Command(BaseCommand):
"""Clean old trickets""" """Clean old trickets"""

10
cas_server/models.py
View File

@ -15,9 +15,17 @@ from .default_settings import settings, SessionStore
from django.db import models from django.db import models
from django.db.models import Q from django.db.models import Q
from django.contrib import messages from django.contrib import messages
from django.utils.translation import ugettext_lazy as _
from django.utils import timezone from django.utils import timezone
try:
from django.utils.encoding import python_2_unicode_compatible from django.utils.encoding import python_2_unicode_compatible
from django.utils.translation import ugettext_lazy as _
except ImportError:
def python_2_unicode_compatible(func):
"""
We use Django >= 3.0 with Python >= 3.4, we don't need Python 2 compatibility.
"""
return func
from django.utils.translation import gettext_lazy as _
from django.core.mail import send_mail from django.core.mail import send_mail
import re import re

0
cas_server/static/cas_server/styles.css → cas_server/static/cas_server/bs3/styles.css
View File

2
cas_server/static/cas_server/bs4/fa-lock.svg Normal file
View File

@ -0,0 +1,2 @@
<!-- Icon by Font Awesome, https://fontawesome.com/, Creative Common 4.0 Attribution -->
<svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="lock" class="svg-inline--fa fa-lock fa-w-14" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path fill="currentColor" d="M400 224h-24v-72C376 68.2 307.8 0 224 0S72 68.2 72 152v72H48c-26.5 0-48 21.5-48 48v192c0 26.5 21.5 48 48 48h352c26.5 0 48-21.5 48-48V272c0-26.5-21.5-48-48-48zm-104 0H152v-72c0-39.7 32.3-72 72-72s72 32.3 72 72v72z"></path></svg>
Side by Side

After

Width:  |  Height:  |  Size: 529 B

2
cas_server/static/cas_server/bs4/fa-user.svg Normal file
View File

@ -0,0 +1,2 @@
<!-- Icon by Font Awesome, https://fontawesome.com/, Creative Common 4.0 Attribution -->
<svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="user" class="svg-inline--fa fa-user fa-w-14" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path fill="currentColor" d="M224 256c70.7 0 128-57.3 128-128S294.7 0 224 0 96 57.3 96 128s57.3 128 128 128zm89.6 32h-16.7c-22.2 10.2-46.9 16-72.9 16s-50.6-5.8-72.9-16h-16.7C60.2 288 0 348.2 0 422.4V464c0 26.5 21.5 48 48 48h352c26.5 0 48-21.5 48-48v-41.6c0-74.2-60.2-134.4-134.4-134.4z"></path></svg>
Side by Side

After

Width:  |  Height:  |  Size: 573 B

34
cas_server/static/cas_server/bs4/styles.css Normal file
View File

@ -0,0 +1,34 @@
html, body {
height: 100%;
background-color: #eee;
}
.cover-container {
max-width: 50em;
}
/* Page title */
#app-name {
color: #000;
text-shadow: 0 .05rem .2rem rgba(255, 255, 255, .5);
}
#app-name img {
width: 110px;
margin-right: 1rem;
}
@media screen and (max-width: 680px) {
#app-name img {
display: block;
margin: auto;
}
}
/* Add icons to login form */
/* Font-Awesome attribution is already done inside SVG files */
.form-signin input[type="text"] {
background: right 1rem top 50% / 5% no-repeat url('fa-user.svg');
padding-right: 3rem;
}
.form-signin input[type="password"] {
background: right 1rem top 50% / 5% no-repeat url('fa-lock.svg');
padding-right: 3rem;
}

2
cas_server/templates/cas_server/base.html → cas_server/templates/cas_server/bs3/base.html
View File

@ -13,7 +13,7 @@
<script src="{{settings.CAS_COMPONENT_URLS.respond}}"></script> <script src="{{settings.CAS_COMPONENT_URLS.respond}}"></script>
<![endif]--> <![endif]-->
{% if settings.CAS_FAVICON_URL %}<link rel="shortcut icon" href="{{settings.CAS_FAVICON_URL}}" />{% endif %} {% if settings.CAS_FAVICON_URL %}<link rel="shortcut icon" href="{{settings.CAS_FAVICON_URL}}" />{% endif %}
<link href="{% static "cas_server/styles.css" %}" rel="stylesheet"> <link href="{% static "cas_server/bs3/styles.css" %}" rel="stylesheet">
</head> </head>
<body> <body>
<div id="wrap"> <div id="wrap">

0
cas_server/templates/cas_server/form.html → cas_server/templates/cas_server/bs3/form.html
View File

2
cas_server/templates/cas_server/logged.html → cas_server/templates/cas_server/bs3/logged.html
View File

@ -1,4 +1,4 @@
{% extends "cas_server/base.html" %} {% extends "cas_server/bs3/base.html" %}
{% load i18n %} {% load i18n %}
{% block content %} {% block content %}
<div class="alert alert-success" role="alert">{% blocktrans %}<h3>Log In Successful</h3>You have successfully logged into the Central Authentication Service.<br/>For security reasons, please Log Out and Exit your web browser when you are done accessing services that require authentication!{% endblocktrans %}</div> <div class="alert alert-success" role="alert">{% blocktrans %}<h3>Log In Successful</h3>You have successfully logged into the Central Authentication Service.<br/>For security reasons, please Log Out and Exit your web browser when you are done accessing services that require authentication!{% endblocktrans %}</div>

4
cas_server/templates/cas_server/login.html → cas_server/templates/cas_server/bs3/login.html
View File

@ -1,4 +1,4 @@
{% extends "cas_server/base.html" %} {% extends "cas_server/bs3/base.html" %}
{% load i18n %} {% load i18n %}
{% block ante_messages %} {% block ante_messages %}
@ -9,7 +9,7 @@
{% block content %} {% block content %}
<form class="form-signin" method="post" id="login_form"{% if post_url %} action="{{post_url}}"{% endif %}> <form class="form-signin" method="post" id="login_form"{% if post_url %} action="{{post_url}}"{% endif %}>
{% csrf_token %} {% csrf_token %}
{% include "cas_server/form.html" %} {% include "cas_server/bs3/form.html" %}
{% if auto_submit %}<noscript>{% endif %} {% if auto_submit %}<noscript>{% endif %}
<button class="btn btn-primary btn-block btn-lg" type="submit">{% trans "Login" %}</button> <button class="btn btn-primary btn-block btn-lg" type="submit">{% trans "Login" %}</button>
{% if auto_submit %}</noscript>{% endif %} {% if auto_submit %}</noscript>{% endif %}

2
cas_server/templates/cas_server/logout.html → cas_server/templates/cas_server/bs3/logout.html
View File

@ -1,4 +1,4 @@
{% extends "cas_server/base.html" %} {% extends "cas_server/bs3/base.html" %}
{% load static %} {% load static %}
{% load i18n %} {% load i18n %}
{% block content %} {% block content %}

4
cas_server/templates/cas_server/warn.html → cas_server/templates/cas_server/bs3/warn.html
View File

@ -1,11 +1,11 @@
{% extends "cas_server/base.html" %} {% extends "cas_server/bs3/base.html" %}
{% load static %} {% load static %}
{% load i18n %} {% load i18n %}
{% block content %} {% block content %}
<form class="form-signin" method="post"> <form class="form-signin" method="post">
{% csrf_token %} {% csrf_token %}
{% include "cas_server/form.html" %} {% include "cas_server/bs3/form.html" %}
<button class="btn btn-primary btn-block btn-lg" type="submit">{% trans "Connect to the service" %}</button> <button class="btn btn-primary btn-block btn-lg" type="submit">{% trans "Connect to the service" %}</button>
</form> </form>
{% endblock %} {% endblock %}

91
cas_server/templates/cas_server/bs4/base.html Normal file
View File

@ -0,0 +1,91 @@
{% load i18n %}{% load static %}{% get_current_language as LANGUAGE_CODE %}<!DOCTYPE html>
<html{% if LANGUAGE_CODE %} lang="{{LANGUAGE_CODE}}"{% endif %}>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>{% block title %}{% trans "Central Authentication Service" %}{% endblock %}</title>
<link href="{{settings.CAS_COMPONENT_URLS.bootstrap4_css}}" rel="stylesheet" crossorigin="anonymous">
{% if settings.CAS_FAVICON_URL %}<link rel="shortcut icon" href="{{settings.CAS_FAVICON_URL}}" />{% endif %}
<link href="{% static "cas_server/bs4/styles.css" %}" rel="stylesheet">
</head>
<body>
<div class="cover-container d-flex w-100 h-100 p-3 mx-auto flex-column">
{% if auto_submit %}<noscript>{% endif %}
<header class="mb-auto">
<h1 id="app-name" class="text-center">
{% if settings.CAS_LOGO_URL %}<img src="{{settings.CAS_LOGO_URL}}" alt="cas-logo" />{% endif %}
{% trans "Central Authentication Service" %}
</h1>
{% for msg in CAS_INFO_RENDER %}
<div class="alert alert-{{msg.type}}{% if msg.discardable %} alert-dismissable{% endif %}">
{% if msg.discardable %}<button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>{% endif %}
{{msg.message}}
</div>
{% endfor %}
{% if settings.CAS_NEW_VERSION_HTML_WARNING and upgrade_available %}
<div class="alert alert-info alert-dismissable">
<button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>
<p>{% blocktrans %}A new version of the application is available. This instance runs {{VERSION}} and the last version is {{LAST_VERSION}}. Please consider upgrading.{% endblocktrans %}</p>
</div>
{% endif %}
</header>
{% if auto_submit %}</noscript>{% endif %}
<main class="card border-dark mx-auto" style="max-width: 30rem;">
{% block ante_messages %}{% endblock %}
<div class="card-body">
{% for message in messages %}
<div {% spaceless %}
{% if message.level == message_levels.DEBUG %}
class="alert alert-warning"
{% elif message.level == message_levels.INFO %}
class="alert alert-info"
{% elif message.level == message_levels.SUCCESS %}
class="alert alert-success"
{% elif message.level == message_levels.WARNING %}
class="alert alert-warning"
{% else %}
class="alert alert-danger"
{% endif %}
{% endspaceless %}>
<p>{{message}}</p>
</div>
{% endfor %}
{% block content %}{% endblock %}
</div>
</main>
{% if settings.CAS_SHOW_POWERED %}
<footer class="mt-auto">
<p class="text-center">
<a class="text-muted" href="https://pypi.org/project/django-cas-server/">
django-cas-server powered
</a>
</p>
</footer>
{% endif %}
</div>
<script src="{{settings.CAS_COMPONENT_URLS.jquery}}" crossorigin="anonymous"></script>
<script src="{{settings.CAS_COMPONENT_URLS.bootstrap4_js}}" crossorigin="anonymous"></script>
<script src="{% static "cas_server/functions.js" %}"></script>
<script type="text/javascript">
{% if settings.CAS_NEW_VERSION_HTML_WARNING and upgrade_available %}
discard_and_remember("#alert-version", "cas-alert-version", "{{LAST_VERSION}}");
{% endif %}
{% for msg in CAS_INFO_RENDER %}
{% if msg.discardable %}
discard_and_remember("#info-{{msg.name}}", "cas-info-{{msg.name}}", "{{msg.hash}}");
{% endif %}
{% endfor %}
{% block javascript_inline %}{% endblock %}
</script>
{% block javascript %}{% endblock %}
</body>
</html>
<!--
Powered by django-cas-server version {{VERSION}}
Pypi: https://pypi.org/project/django-cas-server/
github: https://github.com/nitmir/django-cas-server
-->

33
cas_server/templates/cas_server/bs4/form.html Normal file
View File

@ -0,0 +1,33 @@
{% load cas_server %}
{% for error in form.non_field_errors %}
<div class="alert alert-danger alert-dismissable">
<button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>
{{error}}
</div>
{% endfor %}
{% for field in form %}{% if not field|is_hidden %}
<div class="form-group
{% if not form.non_field_errors %}
{% if field.errors %} has-error
{% elif form.cleaned_data %} has-success
{% endif %}
{% endif %}"
>{% spaceless %}
{% if field|is_checkbox %}
<div class="form-check">
<span class="form-check-input mt-0">{{field}}</span>
<label class="form-check-label" for="{{field.auto_id}}">
{{field.label}}
</label>
</div>
{% else %}
<label class="control-label" for="{{field.auto_id}}">{{field.label|capfirst}}</label>
{{field}}
{% endif %}
{% for error in field.errors %}
<span class="help-block">{{error}}</span>
{% endfor %}
{% endspaceless %}</div>
{% else %}{{field}}{% endif %}{% endfor %}

21
cas_server/templates/cas_server/bs4/logged.html Normal file
View File

@ -0,0 +1,21 @@
{% extends "cas_server/bs4/base.html" %}
{% load i18n %}
{% block content %}
<div class="alert alert-success" role="alert">{% blocktrans %}<h3>Log In Successful</h3>You have successfully logged into the Central Authentication Service.<br/>For security reasons, please Log Out and Exit your web browser when you are done accessing services that require authentication!{% endblocktrans %}</div>
<form class="form-signin" method="get" action="logout">
<div class="checkbox">
<label>
<input type="checkbox" name="all" value="1">{% trans "Log me out from all my sessions" %}
</label>
</div>
{% if settings.CAS_FEDERATE and request.COOKIES.remember_provider %}
<div class="checkbox">
<label>
<input type="checkbox" name="forget_provider" value="1">{% trans "Forget the identity provider" %}
</label>
</div>
{% endif %}
<button class="btn btn-danger btn-block btn-lg" type="submit">{% trans "Logout" %}</button>
</form>
{% endblock %}

33
cas_server/templates/cas_server/bs4/login.html Normal file
View File

@ -0,0 +1,33 @@
{% extends "cas_server/bs4/base.html" %}
{% load i18n %}
{% block ante_messages %}
{% if auto_submit %}<noscript>{% endif %}
<div class="card-header text-center">
<h2 class="form-signin-heading">{% trans "Please log in" %}</h2>
</div>
{% if auto_submit %}</noscript>{% endif %}
{% endblock %}
{% block content %}
<form class="form-signin" method="post" id="login_form"{% if post_url %} action="{{post_url}}"{% endif %}>
{% csrf_token %}
{% include "cas_server/bs4/form.html" %}
{% if auto_submit %}<noscript>{% endif %}
<button class="btn btn-primary btn-block btn-lg" type="submit">{% trans "Login" %}</button>
{% if auto_submit %}</noscript>{% endif %}
</form>
{% endblock %}
{% block javascript_inline %}
jQuery(function( $ ){
$("#id_warn").click(function(e){
if($("#id_warn").is(':checked')){
createCookie("warn", "on", 10 * 365);
} else {
eraseCookie("warn");
}
});
});
{% if auto_submit %}document.getElementById('login_form').submit(); // SUBMIT FORM{% endif %}
{% endblock %}

7
cas_server/templates/cas_server/bs4/logout.html Normal file
View File

@ -0,0 +1,7 @@
{% extends "cas_server/bs4/base.html" %}
{% load static %}
{% load i18n %}
{% block content %}
<div class="alert alert-success" role="alert">{{logout_msg}}</div>
{% endblock %}

11
cas_server/templates/cas_server/bs4/warn.html Normal file
View File

@ -0,0 +1,11 @@
{% extends "cas_server/bs4/base.html" %}
{% load static %}
{% load i18n %}
{% block content %}
<form class="form-signin" method="post">
{% csrf_token %}
{% include "cas_server/bs4/form.html" %}
<button class="btn btn-primary btn-block btn-lg" type="submit">{% trans "Connect to the service" %}</button>
</form>
{% endblock %}

7
cas_server/utils.py
View File

@ -18,11 +18,12 @@ from django.contrib.messages import constants as DEFAULT_MESSAGE_LEVELS
from django.core.serializers.json import DjangoJSONEncoder from django.core.serializers.json import DjangoJSONEncoder
from django.utils import timezone from django.utils import timezone
from django.core.exceptions import ValidationError from django.core.exceptions import ValidationError
from django.utils.translation import ugettext_lazy as _
try: try:
from django.urls import reverse from django.urls import reverse
from django.utils.translation import gettext_lazy as _
except ImportError: except ImportError:
from django.core.urlresolvers import reverse from django.core.urlresolvers import reverse
from django.utils.translation import ugettext_lazy as _
import re import re
import random import random
@ -258,7 +259,7 @@ def update_url(url, params):
value = value.encode('utf-8') value = value.encode('utf-8')
params[key] = value params[key] = value
url_parts = list(urlparse(url)) url_parts = list(urlparse(url))
query = dict(parse_qsl(url_parts[4])) query = dict(parse_qsl(url_parts[4], keep_blank_values=True))
query.update(params) query.update(params)
# make the params order deterministic # make the params order deterministic
query = list(query.items()) query = list(query.items())
@ -593,7 +594,9 @@ class LdapHashUserPassword(object):
if scheme in cls.schemes_nosalt: if scheme in cls.schemes_nosalt:
return b"" return b""
elif scheme == b'{CRYPT}': elif scheme == b'{CRYPT}':
if b'$' in hashed_passord:
return b'$'.join(hashed_passord.split(b'$', 3)[:-1])[len(scheme):] return b'$'.join(hashed_passord.split(b'$', 3)[:-1])[len(scheme):]
return hashed_passord.split(b'}', 1)[-1]
else: else:
try: try:
hashed_passord = base64.b64decode(hashed_passord[len(scheme):]) hashed_passord = base64.b64decode(hashed_passord[len(scheme):])

14
cas_server/views.py
View File

@ -16,12 +16,20 @@ from django.shortcuts import render, redirect
from django.http import HttpResponse, HttpResponseRedirect from django.http import HttpResponse, HttpResponseRedirect
from django.contrib import messages from django.contrib import messages
from django.utils.decorators import method_decorator from django.utils.decorators import method_decorator
from django.utils.translation import ugettext as _
from django.utils import timezone from django.utils import timezone
from django.views.decorators.csrf import csrf_exempt from django.views.decorators.csrf import csrf_exempt
from django.middleware.csrf import CsrfViewMiddleware from django.middleware.csrf import CsrfViewMiddleware
from django.views.generic import View from django.views.generic import View
try:
from django.utils.encoding import python_2_unicode_compatible from django.utils.encoding import python_2_unicode_compatible
from django.utils.translation import ugettext as _
except ImportError:
def python_2_unicode_compatible(func):
"""
We use Django >= 3.0 with Python >= 3.4, we don't need Python 2 compatibility.
"""
return func
from django.utils.translation import gettext as _
from django.utils.safestring import mark_safe from django.utils.safestring import mark_safe
try: try:
from django.urls import reverse from django.urls import reverse
@ -256,7 +264,7 @@ class FederateAuth(CsrfExemptView):
self.service_url = service_url self.service_url = service_url
return CASFederateValidateUser(provider, service_url, renew=renew) return CASFederateValidateUser(provider, service_url, renew=renew)
def post(self, request, provider=None): def post(self, request, provider=None, *args, **kwargs):
""" """
method called on POST request method called on POST request
@ -1395,7 +1403,7 @@ class SamlValidate(CsrfExemptView):
ticket = None ticket = None
root = None root = None
def post(self, request): def post(self, request, *args, **kwargs):
""" """
method called on POST request on this view method called on POST request on this view

1
requirements-dev.txt
View File

@ -7,6 +7,5 @@ tox>=1.8.1
pytest>=2.6.4 pytest>=2.6.4
pytest-django>=2.8.0 pytest-django>=2.8.0
pytest-pythonpath>=0.3 pytest-pythonpath>=0.3
pytest-warnings
pytest-cov>=2.2.1 pytest-cov>=2.2.1
mock>=1 mock>=1

2
requirements.txt
View File

@ -1,4 +1,4 @@
Django >= 1.11,<2.2 Django >= 1.11,<3.1
setuptools>=5.5 setuptools>=5.5
requests>=2.4 requests>=2.4
requests_futures>=0.9.5 requests_futures>=0.9.5

6
setup.py
View File

@ -34,6 +34,8 @@ if __name__ == '__main__':
'Framework :: Django :: 1.11', 'Framework :: Django :: 1.11',
'Framework :: Django :: 2.0', 'Framework :: Django :: 2.0',
'Framework :: Django :: 2.1', 'Framework :: Django :: 2.1',
'Framework :: Django :: 2.2',
'Framework :: Django :: 3.0',
'Intended Audience :: Developers', 'Intended Audience :: Developers',
'Intended Audience :: System Administrators', 'Intended Audience :: System Administrators',
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
@ -44,6 +46,8 @@ if __name__ == '__main__':
'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Topic :: Software Development :: Libraries :: Python Modules', 'Topic :: Software Development :: Libraries :: Python Modules',
'Topic :: Internet :: WWW/HTTP', 'Topic :: Internet :: WWW/HTTP',
'Topic :: Internet :: WWW/HTTP :: Dynamic Content', 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
@ -58,7 +62,7 @@ if __name__ == '__main__':
}, },
keywords=['django', 'cas', 'cas3', 'server', 'sso', 'single sign-on', 'authentication', 'auth'], keywords=['django', 'cas', 'cas3', 'server', 'sso', 'single sign-on', 'authentication', 'auth'],
install_requires=[ install_requires=[
'Django >= 1.11,<2.2', 'requests >= 2.4', 'requests_futures >= 0.9.5', 'Django >= 1.11,<3.1', 'requests >= 2.4', 'requests_futures >= 0.9.5',
'lxml >= 3.4', 'six >= 1' 'lxml >= 3.4', 'six >= 1'
], ],
url="https://github.com/nitmir/django-cas-server", url="https://github.com/nitmir/django-cas-server",

58
tox.ini
View File

@ -5,10 +5,13 @@ envlist=
py27-django111, py27-django111,
py35-django111, py35-django111,
py36-django111, py36-django111,
py35-django20, py37-django111,
py36-django20, py36-django22,
py35-django21, py37-django22,
py36-django21, py38-django22,
py36-django30,
py37-django30,
py38-django30,
[flake8] [flake8]
max-line-length=100 max-line-length=100
@ -118,10 +121,51 @@ deps =
Django>=2.1,<2.2 Django>=2.1,<2.2
{[base]deps} {[base]deps}
[testenv:py37-django21]
basepython=python3.7
deps =
Django>=2.1,<2.2
{[base]deps}
[testenv:py36-django22]
basepython=python3.6
deps =
Django>=2.2,<3.0
{[base]deps}
[testenv:py37-django22]
basepython=python3.7
deps =
Django>=2.2,<3.0
{[base]deps}
[testenv:py38-django22]
basepython=python3.8
deps =
Django>=2.2,<3.0
{[base]deps}
[testenv:py36-django30]
basepython=python3.6
deps =
Django>=3.0,<3.1
{[base]deps}
[testenv:py37-django30]
basepython=python3.7
deps =
Django>=3.0,<3.1
{[base]deps}
[testenv:py38-django30]
basepython=python3.8
deps =
Django>=3.0,<3.1
{[base]deps}
[testenv:flake8] [testenv:flake8]
basepython=python basepython=python3
deps=flake8 deps=flake8
skip_install=True skip_install=True
commands= commands=
@ -130,7 +174,7 @@ commands=
whitelist_externals={[post_cmd]whitelist_externals} whitelist_externals={[post_cmd]whitelist_externals}
[testenv:check_rst] [testenv:check_rst]
basepython=python basepython=python3
deps= deps=
docutils docutils
Pygments Pygments
@ -142,7 +186,7 @@ commands=
whitelist_externals={[post_cmd]whitelist_externals} whitelist_externals={[post_cmd]whitelist_externals}
[testenv:coverage] [testenv:coverage]
basepython=python basepython=python3
passenv= passenv=
COVERAGE_TOKEN COVERAGE_TOKEN
CI_BUILD_REF_NAME CI_BUILD_REF_NAME