https://github.com/digitalfox/pydentity

Python Web application to manage Apache password file (htpasswd)
https://github.com/digitalfox/pydentity

Last synced: 6 months ago
JSON representation

Python Web application to manage Apache password file (htpasswd)

• Host: GitHub
• URL: https://github.com/digitalfox/pydentity
• Owner: digitalfox
• Archived: true
• Created: 2015-08-23T16:41:21.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-04-01T17:19:33.000Z (over 3 years ago)
• Last Synced: 2025-02-13T14:17:00.304Z (over 1 year ago)
• Language: Python
• Size: 62.5 KB
• Stars: 10
• Watchers: 3
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# What is it ?

Pydentity is a small web application that manage apache password file (htpasswd) with 

a simple browser.

Current features are:

- change your password by providing the previous one

- change other people password when you belongs the a specified admin group

- create new users

- check password strength. The requirements pattern can be changed in conf. Default is lower case, numeric and special char or uppercase with a length > 8). It is checked at browser *and* server level

- redirect to custom page (given as args in url ex. /user/user1?return_to=/myapp/) after successful password change or user creation

- change user groups belonging

- handle authentication through http basic authentication (of course)

Caveats, limitations, so far:

- only md5 password hash are supported. Of course crypt password will never be. Blowfish could be supported one day

- only support http authentication. But frankly, if you want to manage htpasswd file you should have that don't you ?

- no group creation, user can be added or removed from existing groups only

# How it works ?

Pydentity is developped on [python](http://www.python.org) and based on the micro framework [Flask](http://flask.pocoo.org/).

To handle htpasswd file format, it relies on python [htpasswd library](https://github.com/thesharp/htpasswd)

and [openssl](https://www.openssl.org/). No database is required.

Obviously, you need a WSGI compliant web server. It is tested with [Apache](http://httpd.apache.org/)

and [mod_wsgi](http://code.google.com/p/modwsgi/), but it should works with others (Gunicorn, Werkzeurg, uWSGI etc.)

# License

Pydentity is licensed under the [GNU Affero General Public Licence version 3 or newer](http://www.gnu.org/licenses/agpl-3.0.html)

# Authors

- Sebastien Renard (sebastien.renard@digitalfox.org): creator, maintainer

- Fabien Beziaud (fabien.beziaud@gmail.com): extended regexp support and others patches

# Installation

Prerequisites: 

- python 2.7

- WSGI compliant server (example: apache and mod_wsgi)

- openssl command line

Just drop the code where you want in a place that your webserver can read. You are advised to create a dedicated python

virtual environment to install python third party libs, but it's up to you! The pydentity.wsgi file is setup with a

virtual env named "venv" at the root code level. If you don't use virtual env, comment this line, else, adapt it 

to you virtual env location. Install python requirements with this simple line:

 

 pip install -r requirement

Then setup your Webserver to target pydidentity.wsgi file. Here's a sample Apache + mod_wsgi configuration snippet

you could put in a virtual env definition:

    

        AuthName "pydentity"

        AuthType Basic

        AuthUserFile /var/www/htpasswd

        Require valid-user

    

    WSGIDaemonProcess pydentity threads=5 maximum-requests=10000 display-name=pydentity

    WSGIScriptAlias / /var/www/pydentity/pydentity.wsgi

    

        WSGIProcessGroup pydentity

        WSGIApplicationGroup %{GLOBAL}

        Order deny,allow

        Allow from all

    

# Configuration

Application configuration is very limited. Everything is in the prologue of pydentidy.py file in the CONF dict.

Here's the parameters you may want to tune:

    PWD_FILE: Full path to the htpasswd file to manage. Default to /htpasswd,

    GROUP_FILE: Full path the group file to manage. Default to /htgroup

    ADMIN_GROUP: Name of the admin group. Default to "admin". User need to belong to this group to be able to change other user password or create new users. REQUIRE_REMOTE_USER parameter is required

    REQUIRE_REMOTE_USER: Whether to require http basic auth upstream (for example with apache). Default to True. If False, everyone is able to change anyone password if the correct previous one is provided.

# Development configuration

We encourage you to use a Python Virtual Environment such as [virtualenv](https://docs.python.org/3/tutorial/venv.html)

or [pipenv](https://pypi.org/project/pipenv/).

Install python requirements with this simple line:

    pip install -r requirement

Then you can simply use the Flask dev server for development:

    export FLASK_APP=hello.py

    export FLASK_ENV=development

    flask run