ouistiti

Ouistiti - Kleiner HTTP -Server

Ouistiti

Ouistiti (ˈWistiti) ist der französische Name von Marmoset, ein kleiner Affe der Neuen Welt.

Ouistiti ist ein kleiner Webserver zum Verwalten und Konfigurieren kleiner Geräte. Es ermöglicht das Erstellen einer einheitlichen Weboberfläche für Sicherheit in Dokumenten , Websocket , Rest -API und mehr.

Ouistiti ist für die Steuerung von einem Webserver auf dem Gerät eingebettet.

Bei Ouistiti werden alle Seiten, Websockets und Skripte auf die gleiche Weise geschützt. Es ist nutzlos, die Authentifizierung nach Ihrem Selbst zu verwalten.

Merkmale

Multi -HTTP -Versionen:

• HTTP/0.9 HTTP/1.0 HTTP/1.1 : Ouistiti kann jede Version des HTTP -Protokolls aus den Anforderungen verwalten oder nur die Anforderungen einer Version akzeptieren.
• Keep Award Connection: Eine Client -Verbindung kann für mehrere Anfragen verwendet werden.
• Pipeline -Anfragen: Ouistiti kann während der Verwaltung des vorherigen in derselben Verbindung eine Anfrage erhalten.

Sichern http - https :

Die TLS/SSL -Verbindung ist als Modul mit MbedTLS oder OpenSSL -Bibliothek erhältlich.

Authentifizierung:

Die Authentifizierung ist in allen Kundenverbindungen verfügbar. Das Passwort der Benutzer kann für den Speicher verschlüsselt werden. Die folgende Herausforderung wird unterstützt:

• Grundlegende Authentifizierung : Ouistiti kann die Benutzer auf einfachste Weise überprüfen.
• Digest Authentication : Ouistiti ermöglicht das Erstellen Ihrer Verbindungsseite und die Überprüfung der Rechte.
• Trägerauthentifizierung : Ouistiti kann ein Token erstellen, und alle Fälle von Ouistiti können dieses Token in derselben Netzwerkdomäne überprüfen.
• OpenID -Authentifizierung : Verwalten Sie die Benutzer auf einem OpenID -Server (wie Google) und Ouistiti überprüft die Rechte des Benutzers.

Websocket:

Ein Modul erstellt eine Websocket -Brücke zwischen dem HTTP -Socket -Client und der UNIX -Socket. Es ist in der Lage, den Handschlag und die Datenübertragung in Ihre Anwendung zu verwalten. Sie entwickeln einen Cammands -Server auf einem Unix -Socket, Ouistiti schützt ihn mit einer HTTPS -Verbindung und seinem Authentifizierungstor. Sie können ein Beispiel für Server finden:

• Chat -Server
• JSONRPC -Server
• SQLite DB Server
• Sparsamkeitserver

Webstream:

Wie das Websocket kann Ouistiti den Server Ihres Streams schützen. Ihre Anwendung sollte nur Daten in einem UNIX -Socket senden, Ouistiti macht den Rest.

• MP3 -Musik mit Pumpe Up the Volume.
• Motion-JPEG Streamer, um Kamera über http zu streamen.
• JSON Data Streamer.

Statische Dokumente:

Wie jeder Webserver kann Ouistiti alle Arten von Dateien an Ihren Client senden. Gleichzeitig kann es sie auf Ihrem Server verwalten:

• REST -API : Es ermöglicht das Verwalten der Dokumentdateien mit einer REST -API zum Hochladen, Löschen und Umbenennen der Dateien direkt auf dem Server.
• Home Directory : Jeder Benutzer kann sein eigenes Verzeichnis mit seinen privaten Rechten verwalten.
• Bereichsanforderung : Die Datei kann für den Download in viele Brocken aufgeteilt werden.

CGI/1.1:

CGI -Skripte können vom Client aufgerufen werden.

Umleiten:

Einige URI müssen auf einem anderen URI umgeleitet werden. Dieses Modul erledigt dies nur mit einer Konfigurationsdatei.

• Datei zu einer anderen Datei.
• Fehler zu einer Datei.
• Erzeugen Sie-204, um ein WiFi-Gateway zu emulieren.

Verbindungsfilterung:

Der Server kann mit einer schwarzen Liste und einer Whitelist der IP -Adresse beginnen.

Benutzer filtern:

Der Server speichert in eine Datenbank die Regeln für URI -Zugriff. Eine Regel ist eine Kombination aus "Rollen" der Benutzer, der Art der Anforderung und einem Ausdruck auf dem URI. Jede Anfrage wird nach der Authentifizierung und vor dem Zugriff auf die Ressource überprüft.

Das Modul enthält seine eigene Wiederherstellung , um die Datenbank festzulegen, und verwendet das Authentifizierungsmodul für die Rechteprüfung.

Upgrade:

Dieses Modul kann eine Verbindung aufrüsten und Daten zwischen dem geöffneten Socket und einem UNIX -Socket -Server übertragen.

Der UNIX -Server kann alle Arten von Daten in den Socket senden und empfangen. Es ermöglicht die Wiederverwendung eines unsicheren Servers und verwendet die HTTP -Funktionen wie Authentifizierung und TLS -Verbindung.

Es ist für das WebSocket -Modul geschlossen, kann jedoch für ein Protokoll über HTTP nützlich sein.

Python:

In diesem Modul wird der Python -Interpretor ausgeführt, um Skripte aufzurufen. Derzeit ist dieses Modul in der Inszenierung und möchte die Django -Website ausführen.

Mono -Threading oder Multi -Threading:

Ouistiti kann erstellt werden, um Clientverbindungen mit nur einem Prozess zu verwalten, um der schnellste Webserver zu sein. Oder es kann für jede Client -Verbindung einen Unabhängigkeitsprozess erstellen, um eine Sandkiste um sie herum zu erstellen.

Abhängigkeiten

Ouistiti soll auf einem Maximum des Systems aufgebaut werden. Der Code ist C99 -konform, die Threads können deaktiviert und die Konfiguration aus dem Speicher geladen werden.

libhttpserver (libouistiti)

Ouistiti wird über die Bibliothek libhttpserver aufgebaut. Diese Bibliothek enthält HTTP -Parser, das Management des Sockets und einige generische Module.

Das Projekt ist auf GitHub erhältlich

libhttpServer kann in libouistiti umbenannt werden, wenn die Quellen der Bibliothek im Ouistiti -Projekt verfügbar sind.

libb64

Das Projekt LIBB64 ist mit einigen Patches obligatorisch. Die Quelle ist im Ouistiti-Project oder im Ouistiti- Projekt erhältlich.

Kryptografische Bibliothek

Die Unterstützung von SSL/TLS kann von mehreren Bibliotheken bereitgestellt werden:

• MBETTLS -Bibliothek
• OpenSSL -Bibliothek

Für den Authentifizierungsdialog mit dem Client kann das Kennwort mit dem MD5 -Algorithmus verschlüsselt werden (dieser ist nicht sicher, ist jedoch zumindest für die Basis- und Verdauungsauthentifizierung obligatorisch). Wenn SSL/TLS nicht verfügbar ist, ist eine MD5 -Bibliothek für Authentifizierungsmodule obligatorisch:

• MD5-C-Bibliothek
• LIBMD5-RFC-Bibliothek

Threadbibliothek

Ouistiti verwendet möglicherweise nicht die PThread -Bibliothek, dies hängt von der Konfiguration ab. Einige Tools verwenden jedoch möglicherweise die PThread -Bibliothek wie WebSocket -Server.

Konfiguration

Ouistiti verwendet die Bibliothek Libconfig, um die Server und die verschiedenen Module festzulegen.

Dokumentation: mod_auth

Andere Bibliotheken

• Jansson Library für JWT im Authentifizierungsmodul
• SQLite -Bibliothek zur Verwaltung der Benutzerdatenbank der Authentifizierung

Plattformen Support

Die erste Version lief auf Linux und Windows. Derzeit wird nur die Linux -Version getestet.

Bau und Installation

Herunterladen

Der erste Schritt laden Sie den Quellbaum herunter.

    $ git clone https://github.com/ouistiti-project/ouistiti

Und das libhttpserver -Projekt

    $ git clone https://github.com/ouistiti-project/libhttpserver

Es gibt 2 Möglichkeiten zu bauen:

• Bauen Sie den libhtppserver außerhalb des Ouistiti -Baumes
• Fügen Sie das Verzeichnis libhttpserver in die Wurzel von Ouistiti hinzu

Konfiguration

Das Projekt verwendet Makemore, um alle Binärdateien zu erstellen.

Makemore enthält eine Gnumake -Datei und ein Konfigurationsskript . Das Skript wird verwendet, um eine Konfigurationsdatei aus der Datei Standard.config zu schreiben. Mit Konfiguration können Sie die Installationsverzeichnisse und die zu erstellenden Teile auswählen.

$ ./configure --prefix=/usr --libdir=/usr/lib/ouistiti --sysconfdir=/etc/ouistiti

Makemore kann als Kbuild Makefile laufen. Es ist möglich, eine Konfigurationsdatei direkt mit Made auszuwählen.

Weitere Konfigurationen sind in Konfigurationen/ Verzeichnissen verfügbar: * fastmono_defconfig für einen Fast Server, jedoch ohne Absturzschutz. * FILLFORKED_DEFCONFIG für einen Server, der nach einem Absturz einer Verbindung weiter laufen kann.

$ make fastmono_defconfig

oder

$ make fullforked_defconfig

oder für eine Standardkonfiguration:

$ make defconfig

Für ein eingebettetes Gerät wie ein Gateway oder eine Schachtel wird die fullfiled_defconfig empfohlen.

Konfiguration erstellen:

Die Konfiguration ist eine Textdatei mit Feldern und Werten. Die Defconfig -Datei im Stammverzeichnis darf nicht geändert werden. Es ist möglich, eine vorhandene Datei in Konfigurationen/ Verzeichnis zu ändern oder zu kopieren.

Die Felder

• Datei_Config: Verwenden Sie die Datei ouistiti.conf für die Konfiguration.

• Vthread: Aktivieren Sie das Multithreading in den Server.

• Vthread_type: Nehmen Sie einen Wert wie [Fork | pThread | Windows], um zu geben, wie man Threads verwaltet.

• Statisch: Erstellen Sie die Anwendung, Bibliotheken (libhttpserver, libouiutils ...) und Module in eine eigenständige binäre.

• Freigegeben: Erstellen/Verknüpfen Sie die dynamischen Bibliotheken (libhttpserver, ...) und die Anwendung mit integrierten Modulen.

• Module: Erstellen Sie die Module als dynamische Bibliotheken. Die Anwendung lädt zur Laufzeit.

• Max_Servers: Erlauben Sie, die Anzahl der Server und virtuellen Hosts auszuwählen.

Modulkonfiguration:

• MbedTLS: Bauen Sie die SSL/TLS -Unterstützung mit MbedTLs auf.
• CGI: Bauen Sie die CGI/1.1 -Unterstützung auf.
• Dokument: Erstellen Sie das Dokumentmodul.
• Auth: Erstellen Sie das Authentifizierungsmodul.
• Vhost: Erstellen Sie die Erweiterung des virtuellen Hostings
• WebSocket: Erstellen Sie das WebSocket -Modul.
• ClientFilter: Erstellen Sie das Verbindungsfiltermodul.
• UserFilter: Erstellen Sie das UserFilter -Modul.

Zusammenstellung

Die Zusammenstellung erfolgt mit GMAKE und akzeptiert die Konfiguration in der Befehlszeile.

Ouistiti ist ein bestimmtes Optionsdebuggen, um Spuren im Code und im Debug -Symbol hinzuzufügen.

$ make DEBUG=y

[Makemore] ermöglicht es, die Kompilierungslinie mit der V -Option zu beobachten:

$ make V=1

Cross Compilation

Ouistiti kann für ein anderes Ziel als den Build -Host aufgebaut werden. Dazu müssen Sie einige Konfigurationen hinzufügen:

• CROSS_COMPILE: Definiert das zu verwendende GCC -Präfix.
• SYSROOT: Definiert den Pfad des Systems, in dem die Tools die Abhängigkeiten finden sollten.

$ make CROSS_COMPILE=arm-linux-gnueabihf

Installation

Die Standardinstallation kopiert die Bibliothek in /usr/local/lib/ verzeichnis und ist mit der Standardkonfiguration in /usr/local/bin . Die Pfade können während der Projektkonfiguration geändert werden (siehe unten)

 > make install

Um vor der Installation einen neuen Baumverzeichnisbaum zu erstellen, kann die Destdir -Variable geändert werden.

 > make DESTDIR= ~ /packages/ouistiti install

Verpackung

Ouistiti wird mit den Rezepten verteilt, um ein Verteilungspaket zu erstellen.

• Bauroot
• Yocto
• Slackware
• Debian

Konfiguration

Ouistiti verwendet libConfig für die Konfiguration. Weitere Informationen zum Konfigurationskapitel finden Sie.

Aufführungen

Binärdateien Größe

Ouistiti ermöglicht die Auswahl jeder Funktion, die Sie während der Build -Konfiguration benötigen. Die Standardkonfiguration ermöglicht es, alle Funktionen an den minimalen Ort zu verwenden.

Hier einige Größen für Arm nach dem Strippen:

• Alle Funktionen statisch verknüpft: 154ko + (MbedTLS, Libconfig, SQLite3, Krypta und C -Bibliotheken)
• Eine kleine Konfiguration (Dokument): 73KO + (C -Bibliothek)
• Mit den Funktionen als Module: 24KO + 158KO von Modulen + 60KO von libhttpserver und anderen Bibliotheken

Speicherverbrauch

Die Speicherverwendung hängt von der Build -Konfiguration und der Anzahl der gleichzeitigen Verbindungen ab.

Mit der Standardkonfiguration für die ARM -Architektur beträgt die Verwendung für den Hauptprozess rund 4,5 Monate und etwa 13,5 Monate für die Verbindung jedes Kunden. Die kleine Konfiguration benötigt jedoch nur 5,5 Monate .

Mit nur einem Prozess in Ouistiti liegt das VMSIZE ungefähr 26 Monate .

Auf der Performance -Seite werden weitere Informationen über die Speichernutzung enthält.

Timing

Ouistiti ist kein Webserver für Big Network, aber es erzielt gute Ergebnisse für die Dokumentbereitstellung. Die Leistungen hängen von der Build -Konfiguration ab und Sie benötigen.

• Um die besten Ergebnisse zu erzielen, muss Ouistiti ohne Thread -Management (vthread = n) erstellt werden.
• Um das Maximum der Sicherheit zu erhalten, muss Ouistiti mit einem Prozess pro Client erstellt werden (vhtread = y und vthread_type = fork).

Ouistiti ist möglicherweise schneller als lightTPD 1.4, jedoch ohne alle Merkmale. Sie finden einige Testergebnisse auf der Auftrittsseite.