Entrify ist eine auf Flask basierende Webanwendung, die entwickelt wurde, um Entra ID App Registration Secrets und SAML-Zertifikate von Enterprise Applications zu verwalten. Sie bietet eine benutzerfreundliche Oberfläche zur Überwachung und Verwaltung von den genannten Entra ID Ressourcen.
- Funktionen
- Technologie-Stack
- Projektstruktur
- Installation
- Konfiguration
- Anwendung starten
- Docker-Bereitstellung
- Docker Compose
- API-Dokumentation
- Authentifizierung
- Datenbank
- Geplante Aufgaben
- Frontend
- Demo
- Mitwirken
- Support
- Entwickler
- Credits
- Dashboard mit Schlüsselmetriken
- Kundenverwaltung
- Verwaltung von App-Registrierungen
- Verwaltung von Unternehmensanwendungen
- SAML-Zertifikatsüberwachung
- App-Registrierungen Secret Überwachung
- Benutzerauthentifizierung (lokal und Entra ID)
- RESTful API-Endpunkte
- Backend: Python 3.9, Flask 2.2.5
- Datenbank: SQLAlchemy mit Unterstützung für MySQL
- Frontend: HTML, CSS, JavaScript
- Authentifizierung: Flask-Login, Flask-Dance (für Entra ID-Integration)
- API: Flask-RESTX
- Aufgabenplanung: Schedule
- Bereitstellung: Docker, Gunicorn, Supervisor
Dieses Projekt basiert auf dem Open-Source-Template Flask Datta Able, das von AppSeed bereitgestellt wird. Es wurde angepasst und erweitert, um den spezifischen Anforderungen von Entrify gerecht zu werden.
Die Anwendung folgt einer modularen Struktur:
entrify/
├── apps/
│ ├── authentication/
│ ├── home/
│ ├── services/
│ ├── static/
│ └── templates/
├── migrations/
├── nginx/
├── .env.sample
├── Dockerfile
├── requirements.txt
├── run.py
└── supervisord.conf
apps/: Enthält den Hauptanwendungscodemigrations/: Datenbankmigrationsscriptenginx/: Nginx-Konfiguration für die BereitstellungDockerfile: Docker-Konfiguration für die Containerisierungrun.py: Einstiegspunkt für die Anwendung
- Klonen Sie das Repository
- Erstellen Sie eine virtuelle Umgebung:
python -m venv venv source venv/bin/activate # Unter Windows verwenden Sie `venv\Scripts\activate` - Installieren Sie die Abhängigkeiten:
pip install -r requirements.txt
- Kopieren Sie
.env.samplezu.env - Aktualisieren Sie die
.env-Datei mit Ihrer spezifischen Konfiguration:- Setzen Sie
DEBUGaufFalsein der Produktion - Konfigurieren Sie die Datenbank-Anmeldeinformationen
- Richten Sie Entra ID-Anmeldeinformationen ein (ENTRA_ID, ENTRA_SECRET, AZURE_TENANT)
- Setzen Sie
Hier sind die wichtigsten Umgebungsvariablen, die Sie konfigurieren sollten:
DEBUG: Setzen Sie dies aufFalsein der ProduktionFLASK_APP: Sollte aufrun.pygesetzt seinFLASK_DEBUG: Setzen Sie dies auf0in der ProduktionENCRYPTION_KEY: Ein starker, einzigartiger Schlüssel für die VerschlüsselungDB_ENGINE: Die zu verwendende Datenbank-Engine (z.B.mysql+pymysql)DB_HOST: Die Adresse des DatenbankserversDB_NAME: Der Name der DatenbankDB_USERNAME: Der Benutzername für die DatenbankverbindungDB_PASS: Das Passwort für die DatenbankverbindungDB_PORT: Der Port für die DatenbankverbindungASSETS_ROOT: Die Basis-URL für statische AssetsENTRA_ID: Die Anwendungs-ID (Client-ID) für Microsoft Entra IDENTRA_SECRET: Das Client-Geheimnis für Microsoft Entra IDAZURE_TENANT: Die Tenant-ID für AzureOAUTHLIB_INSECURE_TRANSPORT: Sollte in der Produktion auf0gesetzt werdenPREFERRED_URL_SCHEME: Sollte in der Produktion aufhttpsgesetzt werden
Um die Anwendung lokal zu starten:
flask run
Für die Produktion verwenden Sie Gunicorn:
gunicorn --config gunicorn-cfg.py run:app
Die Anwendung kann mit Docker bereitgestellt werden:
- Bauen Sie das Docker-Image:
docker build -t entrify . - Führen Sie den Container aus:
docker run -p 5000:5000 entrify
Das Dockerfile ist so konfiguriert, dass es Supervisor zur Verwaltung mehrerer Prozesse innerhalb des Containers verwendet.
Entrify kann auch mit Docker Compose bereitgestellt werden, was die Verwaltung mehrerer Container erleichtert. Hier ist eine kurze Anleitung:
-
Stellen Sie sicher, dass Docker und Docker Compose auf Ihrem System installiert sind.
-
Navigieren Sie zum Projektverzeichnis, das die
docker-compose.ymlDatei enthält. -
Erstellen Sie eine
.envDatei im selben Verzeichnis und füllen Sie sie mit den erforderlichen Umgebungsvariablen aus, einschliesslich der MySQL-Konfiguration. -
Führen Sie den folgenden Befehl aus, um die Container zu starten:
docker-compose up -dDies startet drei Container:
app: Die Entrify-Anwendungnginx: Ein Nginx-Reverse-Proxymysql: Eine MySQL-Datenbank
-
Die Anwendung ist nun über
http://localhost:5085erreichbar. -
Um die Container zu stoppen und zu entfernen, verwenden Sie:
docker-compose down
Beachten Sie, dass die MySQL-Daten in einem benannten Volume mysql_data persistiert werden, um Datenverlust zwischen Container-Neustarts zu vermeiden.
Für die Produktion sollten Sie sicherstellen, dass alle sensiblen Informationen in der .env Datei sicher gespeichert und verwaltet werden.
Die API-Dokumentation ist im Swagger-Format verfügbar und unter https://api-docs.entrify.ch/ zu finden. Die swagger.json-Datei enthält Details zu verfügbaren Endpunkten und deren Verwendung.
Wichtige API-Endpunkte sind:
/api/add-customer: Einen neuen Kunden hinzufügen/api/customers: Alle Kunden abrufen/api/applications: Alle Anwendungen und deren Secret Informationen abrufen/api/enterprise-applications: Alle Unternehmensanwendungen und deren SAML-Zertifikate abrufen
Die Anwendung unterstützt zwei Authentifizierungsmethoden:
- Lokale Authentifizierung mit Benutzername und Passwort
- Entra ID-Authentifizierung mit OAuth 2.0
Die Authentifizierung wird im Modul apps/authentication/ behandelt.
Die Anwendung verwendet SQLAlchemy ORM und unterstützt mehrere Datenbank-Engines. Wichtige Modelle sind:
CustomerApplicationPasswordCredentialEnterpriseApplicationSAMLCertificate
Die Datenbankkonfiguration finden Sie in apps/config.py.
Die Anwendung enthält geplante Aufgaben zur Aktualisierung von Anwendungs- und Zertifikatsinformationen. Diese Aufgaben werden mit der schedule-Bibliothek verwaltet und sind im Verzeichnis apps/services/ konfiguriert.
Das Frontend ist mit HTML-Templates unter Verwendung von Jinja2, CSS und JavaScript aufgebaut. Wichtige Seiten sind:
- Dashboard (
index.html) - Kundenliste (
customers.html) - App-Registrierungen (
app_registrations.html) - Unternehmensanwendungen (
enterprise_applications.html)
Frontend-Assets befinden sich in apps/static/ und Templates in apps/templates/.
Eine Demo Version der Entrify Anwendung ist unter https://dashboard.entrify.ch verfügbar. Diese Demo Instanz ermöglicht es Ihnen, die Funktionen und das Benutzerinterface von Entrify zu erkunden, ohne eine eigene Installation vornehmen zu müssen.
Beiträge zu Entrify sind willkommen. Bitte folgen Sie diesen Schritten:
- Forken Sie das Repository
- Erstellen Sie einen neuen Branch für Ihr Feature
- Committen Sie Ihre Änderungen
- Pushen Sie zu Ihrem Fork
- Reichen Sie einen Pull-Request ein
Für Support kontaktieren Sie bitte support@entrify.ch oder öffnen Sie ein Issue im GitHub-Repository des Projekts.
Mit ❤️ und ☕ wurde die Webanwendung Entrify erstellt.