Introduction

This project is a web interface for Active Directory made using Flask and python-ldap, focusing on ease of use and simplicity.

It's using the connecting user's credentials to connect to the directory and allow a variety of operations.

The goal is to be able to do most common directory operations directly through this web interface rather than have to rely on command tools or Windows interfaces.

It's compatible with both Windows Active Directory and Samba4 domain controllers.

History

This project started as a fork of samba4-manager, created by Stéphane Graber and the Edubuntu community. Was used internally at Havana's Technology University in 2017, and since it has received numerous updates, additions, and changes. We decided to release our version publicly since the original project was not being regularly updated. It has grown since to a much more capable application. The project is now maintained by GSI General Software Inc. We will keep updating the project for our organization and the community, and we are open to all kinds of feedback and contributions.

Install and run

Note: all code has only been tested and it's supported to run on Linux systems, contributions regarding compatibility with other platforms is welcomed.

Local config

Create the .env file in the root directory
- Put a random string in SECRET_KEY**
- Set LDAP_DOMAIN to your Directory domain
- Set SEARCH_DN to your Directory LDAP search base
- Set LDAP_SERVER to your Domain Controller IP
- Use DEBUG = True if you want the test server to immediately reload after changes
- Set USE_LOGGING = True if you want to log to files and console, false logs to console only
- Set ADMIN_GROUP to the security group with read/write permission (default should be Domain Admins)
Create settings.py to configure**
ADD to TREE_BLACKLIST the containers you want to hide in the root directory
Add attribute pairs to SEARCH_ATTRS and TREE_ATTRIBUTES to customize the tree view

Settings.py example:

from decouple import config

class Settings:
    SECRET_KEY = config("SECRET_KEY")
    LDAP_DOMAIN = config("LDAP_DOMAIN")
    SEARCH_DN = config("SEARCH_DN")
    LDAP_DN = config("LDAP_DN", "DC=%s" % ",DC=".join(LDAP_DOMAIN.split(".")))
    LDAP_SERVER = config("LDAP_SERVER")
    DEBUG = config("DEBUG")
    USE_LOGGING = config("USE_LOGGING")
    SICCIP_AWARE = config("SICCIP_AWARE")
    EXTRA_FIELDS = config("EXTRA_FIELDS")
    ADMIN_GROUP = config("ADMIN_GROUP")
    
    TREE_BLACKLIST = [
        "CN=ForeignSecurityPrincipals", "OU=sudoers", "CN=Builtin",
        "CN=Infrastructure", "CN=LostAndFound", "CN=Managed Service Accounts",
        "CN=NTDS Quotas", "CN=Program Data", "CN=System",
        "OU=Domain Controllers", "CN=Guest", "CN=krbtgt"
    ]
    SEARCH_ATTRS = [('sAMAccountName', 'Username'), ('givenName', 'Name')]
    USER_ATTRIBUTES = [
        ["jpegPhoto", "Photo"],
    ]
    TREE_ATTRIBUTES = [
        ['mail', "Email"], ['__type', "Type"], ['active', "Status"]
    ]
#    TIMEZONE = "Your/Timezone"

You can install the dependencies using pip and the supplied requirements.txt. Especial consideration to the python-ldap dependency, which depends on native C libraries and as such needs native compilers and tooling to be installed (check python-ldap docs here).

Installing dependencies in Ubuntu 20.04 (Recommended distro)

apt update
apt install python3-venv python3-pip
apt install build-essential python3-dev libldap2-dev libsasl2-dev slapd ldap-utils tox lcov valgrind
python3 -m venv
. venv/bin/activate
pip install -r requirements.txt

For running in local

python3 ADwebmanager.py

For running with Docker

docker build -t <image name> .
#after image succsessfully built
docker run -d -p 8080:8080 <image name>

You may then connect through http://localhost:8080

Contributing

Contributions are always appreciated!

The project is under the MIT license.

stdevPavelmc/AD-webmanager