Metadata-Version: 2.1
Name: privacyIDEA
Version: 3.7.1
Summary: privacyIDEA: identity, multifactor authentication (OTP), authorization, audit
Home-page: http://www.privacyidea.org
Author: privacyidea.org
Author-email: cornelius@privacyidea.org
License: AGPLv3
Description: privacyIDEA
        ===========
        
        .. image:: https://travis-ci.com/privacyidea/privacyidea.svg?branch=master
            :alt: Build Status
            :target: https://travis-ci.com/privacyidea/privacyidea
        
        .. .. image:: https://circleci.com/gh/privacyidea/privacyidea/tree/master.svg?style=shield&circle-token=:circle-token
        ..     :alt: CircleCI
        ..     :target: https://circleci.com/gh/privacyidea/privacyidea
        
        .. image:: https://codecov.io/gh/privacyidea/privacyidea/coverage.svg?branch=master
            :target: https://codecov.io/gh/privacyidea/privacyidea?branch=master
        
        .. .. image:: https://img.shields.io/pypi/dm/privacyidea.svg
        ..    :alt: Downloads
        ..    :target: https://pypi.python.org/pypi/privacyIDEA/
            
        .. image:: https://img.shields.io/pypi/v/privacyidea.svg
            :alt: Latest Version
            :target: https://pypi.python.org/pypi/privacyIDEA/#history
        
        .. image:: https://img.shields.io/pypi/pyversions/privacyidea.svg
            :alt: PyPI - Python Version
            :target: https://pypi.python.org/pypi/privacyIDEA/
        
        .. image:: https://img.shields.io/github/license/privacyidea/privacyidea.svg
            :alt: License
            :target: https://pypi.python.org/pypi/privacyIDEA/
            
        .. image:: https://readthedocs.org/projects/privacyidea/badge/?version=master
            :alt: Documentation
            :target: http://privacyidea.readthedocs.org/en/master/
        
        .. .. image:: https://codeclimate.com/github/privacyidea/privacyidea/badges/gpa.svg
        ..    :alt: Code Climate
        ..    :target: https://codeclimate.com/github/privacyidea/privacyidea
        
        .. image:: https://api.codacy.com/project/badge/grade/d58934978e1a4bcca325f2912ea386ff
            :alt: Codacy Badge
            :target: https://www.codacy.com/app/cornelius-koelbel/privacyidea
            
        .. image:: https://img.shields.io/twitter/follow/privacyidea.svg?style=social&label=Follow
            :alt: 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.
        
        .. image:: https://privacyidea.org/wp-content/uploads/2017/privacyIDEA-Integration.png
            :alt: privacyIDEA Integration
            :scale: 50 %
        
        privacyIDEA does not bind you to any decision of the authentication
        protocol, nor does it 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, as well
        as FIDO2 WebAuthn 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 `privacyidea.readthedocs.io <http://privacyidea.readthedocs.io/en/latest/installation/index
        .html>`_.
        
        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
            
        .. _testing_env:
        
        You may additionally want to set up your environment for testing, by adding the
        additional dependencies::
        
            pip install -r tests/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
        ===============================
        
        The client-side library for the registering and signing of WebAuthn-Credentials
        resides in a submodule.
        
        To fetch all submodules for this repository, run::
        
           git submodule update --init --recursive
        
        When pulling changes from upstream later, you can automatically update any outdated
        submodules, by running::
        
           git pull --recurse-submodules
        
        Running it
        ==========
        
        First You need to create a `config-file <https://privacyidea.readthedocs
        .io/en/latest/installation/system/inifile.html>`_.
        
        Then create the database and encryption key::
        
            ./pi-manage createdb
            ./pi-manage create_enckey
        
        If You want to keep the development database upgradable, You should `stamp
        <https://privacyidea.readthedocs.io/en/latest/installation/upgrade.html>`_ it
        to simplify updates::
        
            ./pi-manage db stamp head -d migrations/
        
        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
        =========
        
        If you have followed the steps above to set up your
        `environment for testing <#testing-env>`__, running the test suite should be as
        easy as running `pytest <http://pytest.org/>`_ with the following options::
        
            python -m pytest -v --cov=privacyidea --cov-report=html tests/
        
        Contributing
        ============
        
        There are a lot of different ways 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.md
        
        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 <http://semver.org/>`_.
        
Keywords: OTP,two factor authentication,management,security
Platform: UNKNOWN
Classifier: Framework :: Flask
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Internet
Classifier: Topic :: Security
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
Provides-Extra: doc
Provides-Extra: hsm
Provides-Extra: postgres
Provides-Extra: test
