Versatile identity management server
Go to file
Frédéric Péters c0e722fe12 translation update 2021-05-21 08:42:36 +02:00
data [saml2] add a default certificate and aSAML_SIGNING_KEY setting 2010-12-14 16:39:25 +01:00
debian management: add command to cleanup old export files (#52626) 2021-04-15 11:18:33 +02:00
source Initial packaging 2019-05-31 14:51:55 +02:00
src translation update 2021-05-21 08:42:36 +02:00
tests ldap: record user deactivation in journal (#52671) 2021-05-20 18:15:21 +02:00
tests_rbac misc: apply isort (#52457) 2021-03-30 13:59:53 +02:00
.coveragerc .coveragerc: fix omit paths 2015-09-22 11:17:25 +02:00
.git-blame-ignore-revs misc: ignore last commit in git-blame (#53714) 2021-05-04 13:50:21 +02:00
.gitignore ci: add build/ to .gitignore 2020-09-26 14:58:17 +02:00
.gitmodules manager: add gadjo as a submodule (refs #5180) 2014-08-14 11:17:34 +02:00
.pre-commit-config.yaml add isort configuration (#52457) 2021-03-30 14:00:26 +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 add black configuration (#52457) 2021-03-30 11:54:28 +02:00
MANIFEST.in MANIFEST.in: add templates from journal 2020-10-17 09:13:10 +02:00
NEWS Prepare release 2.1.13 2015-03-23 17:25:46 +01:00
README misc: remove documentation files (#53764) 2021-05-06 10:17:21 +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: remove some unused imports (#52457) 2021-03-30 14:00:27 +02:00
pylint.rc update pylint.rc with last version from w.c.s. (#51639) 2021-04-01 09:41:51 +02:00
setup.py misc: remove six module usage (#52503) 2021-03-30 15:06:49 +02:00
tox.ini import pylint config from w.c.s. and simplify launch (#51639) 2021-04-01 07:45:17 +02:00
update-locales.sh add script to update locales 2019-06-22 17:19:09 +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

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.