Versatile identity management server
Go to file
Valentin Deniaud d01300d6f1 translation update 2022-05-19 18:01:47 +02:00
data [saml2] add a default certificate and aSAML_SIGNING_KEY setting 2010-12-14 16:39:25 +01:00
debian debian: allow dependencies to be django-3 compliant (#64305) 2022-05-13 09:49:23 +02:00
source Initial packaging 2019-05-31 14:51:55 +02:00
src translation update 2022-05-19 18:01:47 +02:00
tests auth_oidc: migrate authenticator to database (#53902) 2022-05-19 16:25:12 +02:00
tests_rbac misc: implement soft-delete on RoleParenting (#57500) 2022-03-25 11:14:05 +01:00
.coveragerc .coveragerc: fix omit paths 2015-09-22 11:17:25 +02:00
.git-blame-ignore-revs trivial: update .git-blame-ignore-revs for new black 2022-03-01 19:35:04 +01:00
.gitignore misc: use scss for all css files (#62936) 2022-03-29 10:54:16 +02:00
.gitmodules manager: add gadjo as a submodule (refs #5180) 2014-08-14 11:17:34 +02:00
.pre-commit-config.yaml trivial: bump black version to 22.3.0 2022-03-31 12:12:44 +02:00
AUTHORS.txt AUTHORS: update 2013-11-14 15:54:09 +01:00
COPYING remove authentic2_idp_openid (fixes #23515) 2018-07-01 13:51:44 +02:00
Jenkinsfile Jenkinsfile: run nightly build with django3.2 too (#64305) 2022-05-13 09:53:31 +02:00
MANIFEST.in build: distribute src/authentic2/apps/authenticators/templates/ (#53902) 2022-05-19 17:09:13 +02:00
NEWS Prepare release 2.1.13 2015-03-23 17:25:46 +01:00
README misc: add pyupgrade files/notes (#55519) 2021-07-13 17:23:12 +02:00
authentic2-ctl misc: remove some unused imports (#52457) 2021-03-30 14:00:27 +02:00
check-migrations.sh check-migrations: use mktemp instead of tempfile 2020-08-19 12:51:14 +02:00
getlasso.sh Added tox as a test-runner. 2014-12-11 14:33:49 +01:00
getlasso3.sh python3: add a getlasso3.sh script (#31161) 2019-03-20 17:57:47 +01:00
local_settings.py.example remove authentic2_idp_openid (fixes #23515) 2018-07-01 13:51:44 +02:00
merge-coverage.py misc: apply pyupgrade (#55519) 2021-07-12 12:03:44 +02:00
pylint.rc misc: update pylint configuration (#56982) 2021-09-24 11:21:17 +02:00
pylint.sh pylint.sh: disable echo of command lines 2021-11-29 11:02:18 +01:00
setup.py setup: provide a bullseye's django3 compliant config (#64305) 2022-05-13 09:47:39 +02:00
tox.ini tox: add locale to makemessages command (#64305) 2022-05-13 09:49:23 +02:00
update-locales.sh use tox in update-locales.sh 2021-07-30 14:14:38 +02:00

README

=======================================
Authentic 2 - Versatile Identity Server
=======================================

Authentic 2 is a versatile identity management server aiming to address a
broad range of needs, from simple to complex setups; it has support for many
protocols and can bridge between them.

Authentic 2 supports many protocols and standards, including SAML2, CAS,
LDAP, X509 and OAUTH2.

Authentic 2 is under the GNU AGPL version 3 licence.

It has support for SAMLv2 thanks to `Lasso <http://lasso.entrouvert.org>`_,
a free (GNU GPL) implementation of the Liberty Alliance and OASIS
specifications of SAML2.

Authentic 2 requires Python 2.7 and Django 1.7.

Full documentation available on http://authentic2.readthedocs.org/en/stable/,
maintained in a distinct repository https://git.entrouvert.org/authentic2-doc.git/.

Features
--------

* SAML 2.0 Identity and service provider
* Server CAS 1.0 and 2.0 using a plugin
* Standards authentication mechanisms:

    * Login/password through internal directory or LDAP
    * X509 certificate over SSL/TLS

* Protocol proxying
* Support of LDAP v2 and v3 directories
* Support of the PAM backend
* One-time password (OATH and Google-Authenticator) using a plugin
* Identity attribute management
* Plugin system


Installation
============

First of all, you can boot Authentic vwithout root
privileges  like this:

# Initialize a virtualenv::

    virtualenv authentic
    source ./authentic/bin/activate
    cd authentic

# Install Authentic::

    pip install

# Initialize the database migrations::

    authentic2-ctl syncdb --migrate

# Run the HTTP test server::

    authentic2-ctl runserver

Upgrade
=======
.. WARNING::
   Version 2.2.0 is the first version supporting only Django 1.7, if you are
   using a previous one you must first upgrade to 2.1.12 before tempting
   upgrade to a release later than 2.2.0.

Code Style
==========

black is used to format the code, using thoses parameters:

    black --target-version py37 --skip-string-normalization --line-length 110

There is .pre-commit-config.yaml to use pre-commit to automatically run black
before commits. (execute `pre-commit install` to install the git hook.)

isort is used to format the imports, using those parameter:

    isort --profile black --line-length 110

pyupgrade is used to automatically upgrade syntax, using those parameters:

    pyupgrade --keep-percent-format --py37-plus

There is .pre-commit-config.yaml to use pre-commit to automatically run black,
isort and pyupgrade before commits. (execute `pre-commit install` to install
the git hook.)

Support
=======

Authentic's developpers and users hangs on the mailing list
authentic@listes.entrouvert.com
See archives or register at http://listes.entrouvert.com/info/authentic.

You can "open":http://dev.entrouvert.org/projects/authentic/issues/new bug
reports or feature request on this site.

Entr'ouvert also provides a commercial support. For information, see
http://www.entrouvert.com.


Copyright
=========

Authentic is copyrighted by Entr'ouvert and is licensed through the GNU Affero
General Public Licence, version 3 or later. A copy of the whole license text
is available in the COPYING file.