Metadata-Version: 2.1
Name: basicldap3
Version: 0.1.2
Summary: Provides basic authentication using the ldap3 library
License: MIT
Author: Ramon Brandt
Author-email: devramon22@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: ldap3 (>=2.6.1,<3.0.0)
Description-Content-Type: text/markdown

# Basic LDAP3

Basic LDAP is a small package that uses the ldap3 library. It can be used to authenticate a user against an LDAP server and can check whether the users is in a specific group. In addition it is possible to get user attributes if the authentication is successful.

## Basic example

### Import basicldap and define the server
```python
from basicldap import Ldap

LDAP_HOST = 'ldap.server.com'
LDAP_BASE_DN = 'DC=example,DC=com'

conn = Ldap(LDAP_HOST, LDAP_BASE_DN)

# Using SSL
ssl = {"port": 636, "use_ssl": True}
conn = Ldap(LDAP_HOST, LDAP_BASE_DN, ldap3_args=ssl)
```
### Authenticate the user
```python
conn.authenticate(user_name, password)
```

### Get user attributes (requires successful authentication)
```python
# To get all attributes
conn.get_attributes()

# To get specific attributes
conn.get_attributes(['mail', 'cn])
```
