🔐 multi factor authentication system (2FA, MFA, OTP Server)
Switch branches/tags
Clone or download
Latest commit f5b050c Sep 19, 2018
Permalink
Failed to load latest commit information.
.circleci Update to CircleCI 2.0 from 1.0 Sep 4, 2018
adminclient @ d1de483 set version of adminclient Mar 29, 2016
authmodules remove console.log Jan 24, 2018
contrib Allow to build python-croniter for trusty and xenial Jul 31, 2018
deploy uwsgi: Use saner default values Sep 18, 2018
doc Set version to 2.23.2 Sep 7, 2018
migrations Merge branch 'master' into 747/pre-event-handling Aug 7, 2018
po Fix problem of Typerror when testing LDAP connection Aug 27, 2018
privacyidea Merge pull request #1199 from p53/1131-seed Sep 17, 2018
tests Merge pull request #1199 from p53/1131-seed Sep 17, 2018
tools Add the detailed resolver list to privacyidea-diag Sep 5, 2018
.gitignore temporarily remove submodules May 12, 2017
.gitmodules remove owncloud submodule Jul 7, 2016
.travis.yml Monkeypatch sys.modules to avoid installing PyKCS11 May 29, 2018
AUTHORS.md Added Rene to Authors file Aug 27, 2018
CONTRIBUTING.rst Add information about security vulnerability and disclosure. Aug 20, 2018
Changelog Set version to 2.23.2 Sep 7, 2018
Gruntfile.js Code Cleanup and translation Oct 1, 2015
ISSUE_TEMPLATE.md fix typo Jun 1, 2017
LICENSE init: code cleanup Jun 3, 2014
MANIFEST.in rename README.md to README.rst Mar 15, 2016
Makefile Set version to 2.23.2 Sep 7, 2018
Procfile Add HerokuConfig May 29, 2015
README.rst Add information about security vulnerability and disclosure. Aug 20, 2018
READ_BEFORE_UPDATE.md Fix typo in update notes Aug 27, 2018
coveragerc The flask based privacyidea 2.0 branch Jan 13, 2015
pi-manage Add the detailed resolver list to privacyidea-diag Sep 5, 2018
requirements.txt Require croniter=0.3.24 Jul 31, 2018
setup.py Set version to 2.23.2 Sep 7, 2018

README.rst

privacyIDEA

Build Status CircleCI https://codecov.io/github/privacyidea/privacyidea/coverage.svg?branch=master Latest Version License Documentation Codacy Badge

privacyIDEA on twitter

privacyIDEA is an open solution for strong two-factor authentication like OTP tokens, SMS, smartphones or SSH keys. Using privacyIDEA you can enhance your existing applications like local login (PAM, Windows Credential Provider), VPN, remote access, SSH connections, access to web sites or web portals with a second factor during authentication. Thus boosting the security of your existing applications.

Overview

privacyIDEA runs as an additional service in your network and you can connect different applications to privacyIDEA.

privacyIDEA Integration

privacyIDEA does not bind you to any decision of the authentication protocol or it does not dictate you where your user information should be stored. This is achieved by its totally modular architecture. privacyIDEA is not only open as far as its modular architecture is concerned. But privacyIDEA is completely licensed under the AGPLv3.

It supports a wide variety of authentication devices like OTP tokens (HMAC, HOTP, TOTP, OCRA, mOTP), Yubikey (HOTP, TOTP, AES), FIDO U2F devices like Yubikey and Plug-Up, smartphone Apps like Google Authenticator, FreeOTP, Token2 or TiQR, SMS, Email, SSH keys, x509 certificates and Registration Codes for easy deployment.

privacyIDEA is based on Flask and SQLAlchemy as the python backend. The web UI is based on angularJS and bootstrap. A MachineToken design lets you assign tokens to machines. Thus you can use your Yubikey to unlock LUKS, assign SSH keys to SSH servers or use Offline OTP with PAM.

You may join the discourse discussion forum to give feedback, help other users, discuss questions and ideas: https://community.privacyidea.org

Setup

For setting up the system to run it, please read install instructions at http://privacyidea.readthedocs.io.

If you want to setup a development environment start like this:

git clone https://github.com/privacyidea/privacyidea.git
cd privacyidea
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

You may also want to read the blog post about development and debugging at https://www.privacyidea.org/privacyidea-development-howto/

Getting and updating submodules

Some authentication modules and the admin client are located in git submodules. To fetch the latest release of these run:

git submodule init
git submodule update

Later you can update the submodules like this:

git pull --recurse-submodules

Running it

Create the database and encryption key:

./pi-manage createdb
./pi-manage create_enckey

Create the key for the audit log:

./pi-manage create_audit_keys

Create the first administrator:

./pi-manage admin add <username>

Run it:

./pi-manage runserver

Now you can connect to http://localhost:5000 with your browser and login as administrator.

Run tests

nosetests -v --with-coverage --cover-package=privacyidea --cover-html

Contributing

There are a lot of different way to contribute to privacyIDEA, even if you are not a developer.

If you found a security vulnerability please report it to security@privacyidea.org.

You can find detailed information about contributing here: https://github.com/privacyidea/privacyidea/blob/master/CONTRIBUTING.rst

Code structure

The database models are defined in models.py and tested in tests/test_db_model.py.

Based on the database models there are the libraries lib/config.py which is responsible for basic configuration in the database table config. And the library lib/resolver.py which provides functions for the database table resolver. This is tested in tests/test_lib_resolver.py.

Based on the resolver there is the library lib/realm.py which provides functions for the database table realm. Several resolvers are combined into a realm.

Based on the realm there is the library lib/user.py which provides functions for users. There is no database table user, since users are dynamically read from the user sources like SQL, LDAP, SCIM or flat files.

Versioning

privacyIDEA adheres to Semantic Versioning.