htpasswd

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 22 Open GitHub ↗

Library for working with htpasswd user (only basic authorization) and group files

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# htpasswd [![Build Status](https://secure.travis-ci.org/thesharp/htpasswd.png)](http://travis-ci.org/thesharp/htpasswd)

## Description
**htpasswd** is a library for working with htpasswd user (only basic authorization) and group files. It supports CRYPT, MD5 (based) and MD5 (apache variant, 'apr1') encryption methods. To actually use MD5 encryption method you *MUST* have an ``openssl`` binary installed into system ``$PATH``.

## Dependencies
- Python 2.7 or 3.3 or 3.4
- [orderedmultidict](http://pypi.python.org/pypi/orderedmultidict/0.7) >= 0.7
- [future](https://pypi.python.org/pypi/future)
- [nose](http://pypi.python.org/pypi/nose/) >= 1.1.2 (for tests)

## Sample usage
    import htpasswd

with htpasswd.Basic("/path/to/user.db") as userdb:
        try:
            userdb.add("bob", "password")
        except htpasswd.basic.UserExists, e:
            print e
        try:
            userdb.change_password("alice", "newpassword")
        except htpasswd.basic.UserNotExists, e:
            print e

with htpasswd.Group("/path/to/group.db") as groupdb:
        try:
            groupdb.add_user("bob", "admins")
        except htpasswd.group.UserAlreadyInAGroup, e:
            print e
        try:
            groupdb.delete_user("alice", "managers")
        except htpasswd.group.UserNotInAGroup, e:
            print e

To use MD5 apache variant encryption, add ``mode="md5"`` to the constructor:

with htpasswd.Basic("/path/to/user.db", mode="md5") as userdb

or use ``md5-base`` for MD5 based encryotion:

with htpasswd.Basic("/path/to/user.db", mode="md5-base") as userdb

## Provided methods

### Basic
- ``__contains__(user)``
- ``users``
- ``add(user, password)``
- ``pop(user)``
- ``change_password(user, password)``
- ``_encrypt_password(password)``

### Group
- ``__contains__(group)``
- ``groups``
- ``is_user_in(user, group)``
- ``add_user(user, group)``
- ``delete_user(user,  group)``

## Exceptions

### UserExists
Raised by ``Basic.add`` if user already exists.

### UserNotExists
Raised by ``Basic.delete`` and ``Basic.change_password`` if there is no such user.

### GroupNotExists
Raised by ``Group.delete_user`` if there is no such group.

### UserAlreadyInAGroup
Raised by ``Group.add_user`` if user is already in a group.

### UserNotInAGroup
Raised by ``Group.delete_user`` if user isn't in a group.

### UnknownEncryptionMode
Raised by _encrypt_password if mode is not 'crypt', 'md5' or 'md5-base'.

htpasswd

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README