ouistiti

Ouistiti - маленький HTTP -сервер

Ouistiti

Ouistiti (ˈwistiti) - французское имя Marmoset Маленькая обезьяна нового мира.

Ouistiti - это небольшой веб -сервер для управления и настройки небольших устройств. Он позволяет создавать унифицированный веб -интерфейс для безопасности на документах , WebSocket , REST API и многое другое.

Ouistiti посвящен встроению на устройство для управления веб -сервером.

С ouistiTI все страницы, веб -питания, сценарии защищены одинаковым способом. Бесполезно управлять аутентификацией по себе.

Функции

Multi HTTP -версии:

• Http/0,9 http/1.0 http/1.1 : oistiti способен управлять каждой версией протокола HTTP из запросов или принимать только запросы одной версии.
• Подключение к жизни : клиентское соединение может использоваться для нескольких запросов.
• Запросы на трубопровод : OuistiTI может получать запрос во время управления предыдущим в том же соединении.

Безопасный http - https :

Соединение TLS/SSL доступно в виде модуля с MBedTLS или Library OpenSSL .

Аутентификация:

Аутентификация доступна во всех клиентских соединениях . Пароль пользователей может быть зашифрован для хранения. Поддерживается следующая задача:

• Основная аутентификация : Ouistiti может проверять пользователей самым простым способом.
• Аутентификация Digest : Ouistiti позволяет создавать страницу соединения и проверить права.
• Аутентификация носителя : Ouistiti может создавать токен, и все случаи Ouisti могут проверить этот токен в одном и том же сетевом домене.
• OpenID Authentication : Управляйте пользователями на OpenID -сервере (например, Google), а OuistiTi проверяет права пользователя на нем.

WebSocket:

Модуль строит мост WebSocket между клиентом HTTP Socket и Unix Socket. Он может управлять рукопожатием и передачей данных в ваше приложение. Вы разрабатываете сервер Cammands в сокете Unix, OuistiTi защищает его с помощью подключения HTTPS и его ворота аутентификации. Вы можете найти пример серверов:

• чат -сервер
• jsonrpc server
• SQLite DB Server
• Благотворительный сервер

Webstream:

Как и WebSocket , Ouistiti может защитить сервер вашего потока . Ваше приложение должно отправлять данные только в розетке Unix, OuistiTi делает все остальное.

• MP3 Music трансформируется с накачкой громкость.
• Помогающий стример Motion-Jpeg для передачи камеры через HTTP.
• JSON Data Streamer.

Статические документы:

Как и любой веб -сервер, Ouistiti может отправлять какие -либо виды файлов вашему клиенту. И в то же время он может управлять ими на вашем сервере:

• REST API : он позволяет управлять файлами документов с помощью API REST для загрузки, удаления, переименования файлов непосредственно на сервере.
• Home Directory : Каждый пользователь может управлять своим собственным каталогом с его личными правами .
• Запрос диапазона : файл может быть разделен на множество кусков для загрузки.

CGI/1.1:

Сценарии CGI могут быть вызваны клиентом.

Перенаправить:

Некоторые URI должны быть перенаправлены на другой URI. Этот модуль делает это только с только файлом конфигурации.

• Файл в другой файл.
• ошибка в файл.
• Generate-2014 для эмуляции шлюза Wi-Fi.

Фильтрация соединения:

Сервер может начинаться с черного списка и белого списка IP -адреса.

Пользователи фильтрации:

Сервер хранит в базе данных правила доступа URI. Правило - это комбинация «ролей» пользователя, типа запроса и выражения на URI. Каждый запрос проверяется после аутентификации и до получения доступа к Ressource.

Модуль содержит свой собственный Restapi для установки базы данных и использует модуль аутентификации для проверки прав.

Обновление:

Этот модуль способен обновить соединение и передавать данные между открытым сокетом и сервером Unix Socket.

Сервер UNIX может отправлять и получать какие -либо данные в сокете. Он позволяет повторно использовать небезопасный сервер и использует функции HTTP, такие как аутентификация и соединение TLS.

Он закрыт для модуля WebSocket, но он может быть полезен для некоторого протокола через HTTP.

Питон:

Этот модуль запускает интерпретатор Python для вызова сценариев. В настоящее время этот модуль поставляет и хочет запустить сайт Django.

Монопоточные потоки или многопотоки:

Ouistiti может быть создан для управления клиентскими соединениями только с одним процессом, чтобы быть самым быстрым веб -сервером . Или это может создать процесс независимых для каждого клиентского соединения, чтобы создать песочницу вокруг него.

Зависимости

Ouistiti написан для построения на максимуме системы. Код соответствует C99, потоки могут быть отключены, а конфигурация может быть загружена из памяти.

Libhttpserver (Libouistiti)

Ouistiti строится над библиотекой Libhttpserver. Эта библиотека содержит анализатор HTTP, управление сокетом и некоторые общие модули.

Проект доступен на GitHub

Libhttpserver может быть переименован в Libouistiti , когда источники библиотеки доступны в проекте Oouisti .

libb64

Проект LIBB64 является обязательным с некоторыми участками. Источник доступен в проекте OouistiTi или внутри проекта OUISTI .

Криптографическая библиотека

Поддержка SSL/TLS может быть предоставлена ​​несколькими библиотеками:

• Mbedtls Библиотека
• библиотека OpenSSL

Для диалогового окна аутентификации с клиентом пароль может быть зашифрован с помощью алгоритма MD5 (этот небезопасен, но он является обязательным, по крайней мере, для базовой аутентификации и аутентификации усваивания). Если SSL/TLS недоступен, одна библиотека MD5 является обязательной для модулей аутентификации:

• Библиотека MD5-C
• Библиотека Libmd5-RFC

библиотека

Ouistiti не может использовать библиотеку Pthread, это зависит от конфигурации. Но некоторые инструменты могут использовать библиотеку Pthread, такие как серверы WebSocket.

Конфигурация

Ouistiti использует библиотеку Libconfig, чтобы установить серверы и различные модули.

Документация: mod_auth

Другие библиотеки

• Библиотека Янссона для JWT в модуле аутентификации
• Библиотека SQLite для управления базой данных пользователей аутентификации

Поддержка платформ

Первая версия работала на Linux и Windows. В настоящее время тестируется только версия Linux.

Сборка и установка

Скачать

Первый шаг скачать исходное дерево.

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

И проект Libhttpserver

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

Есть 2 способа построения:

• Построить либтппервервер за пределами дерева Oouistiti
• Добавить каталог Libhttpserver в корень OouistiTi

Конфигурация

Проект использует Makemore для построения всех двоичных файлов.

Makemore содержит файл Gnumake и сценарий настройки . Скрипт используется для написания файла конфигурации из файла default.config . С настройкой вы можете выбрать каталоги установки и детали для построения.

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

Makemore может бежать как kbuild Makefile. Возможно выбрать файл конфигурации напрямую с помощью Make.

Другие конфигурации доступны внутри конфигураций/ каталогов: * fastmono_defconfig для быстрого сервера, но без защиты от удара. * fullforked_defconfig для сервера, который может продолжать работать после сбоя соединения.

$ make fastmono_defconfig

или

$ make fullforked_defconfig

или для конфигурации по умолчанию:

$ make defconfig

Для встроенного устройства, как шлюз или коробку, рекомендуется FullForked_DefConfig .

Построение конфигурации:

Конфигурация - это текстовый файл с полями и значениями. Файл DefConfig в корневом каталоге не должен быть изменен. Можно изменить или скопировать существующий файл в Configs/ Directory.

Поля

• File_config: используйте файл ouistiti.conf для конфигурации.

• Vthread: включите многопоточное чтение на сервер.

• Vthread_type: возьмите значение, подобное [fork | pthread | Windows], чтобы указать, как управлять потоками.

• Статический: построить приложение, библиотеки (Libhttpserver, Libouiutils ...) и модули в автономный бинарник.

• Общий: Создайте/Свяжите динамические библиотеки (Libhttpserver, ...) и приложение с интегрированными модулями.

• Модули: Создайте модули в качестве динамических библиотек, приложение будет загружаться во время выполнения.

• MAX_SERVERS: Разрешить выбрать количество серверов и виртуальных хостов для управления.

Конфигурация модулей:

• MBEDTLS: Постройте поддержку SSL/TLS с помощью MBEDTLS.
• CGI: построить поддержку CGI/1.1.
• Документ: Создайте модуль документа.
• AUTH: Создайте модуль аутентификации.
• Vhost: построить расширение виртуального хостинга
• WebSocket: Создайте модуль WebSocket.
• ClientFilter: Создайте модуль фильтрации подключения.
• UserFilter: Создайте модуль userFilter.

Компиляция

Компиляция выполняется с помощью Gmake и принимает конфигурацию в командной строке.

Ouistiti доступен конкретный вариант отладки для добавления трассов в коде и символа отладки.

$ make DEBUG=y

[Makemore] позволяет наблюдать за линией компиляции с опцией V :

$ make V=1

Cross Compilation

OUISTITI может быть построен для другой цели, чем хост сборки. Для этого вам нужно добавить некоторые конфигурации:

• Cross_compile: определяет префикс GCC для использования.
• Sysroot: определяет путь Sysroot, где инструменты должны найти зависимости.

$ make CROSS_COMPILE=arm-linux-gnueabihf

Установка

Установка по умолчанию скопирует библиотеку в /usr/local/lib/ каталог, а также бинарный в /usr/local/bin с конфигурацией по умолчанию. Пути могут быть изменены во время конфигурации проекта (см. Ниже)

 > make install

Чтобы создать дерево новых каталогов перед установкой, переменная Destdir может быть изменена.

 > make DESTDIR= ~ /packages/ouistiti install

Упаковка

Ouistiti распространяется по рецептам для создания пакета дистрибуции.

• Строительный корн
• yocto
• Slackware
• Дебюн

Конфигурация

Ouistiti использует Libconfig для конфигурации. Найдите больше информации в главе конфигурации.

Выступления

Двоичный размер

Ouistiti позволяет выбрать каждую функцию, которая вам нужна во время конфигурации сборки. Конфигурация по умолчанию позволяет использовать все функции в минимальном месте.

Здесь несколько размеров для рук после счистки:

• Все функции статически связаны: 154KO + (Mbedtls, Libconfig, SQLite3, Crypt и C -библиотеки)
• Небольшая конфигурация (документ): 73KO + (библиотека C)
• С функциями в виде модулей: 24KO + 158KO модулей + 60KO Libhttpserver и других библиотек

Использование памяти

Использование памяти зависит от конфигурации сборки и количества одновременных соединений.

При конфигурации по умолчанию для архитектуры ARM использование составляет около 4,5 млн. Для основного процесса и около 13,5 МО для подключения каждого клиента. Но небольшая конфигурация требует всего 5,5 мес .

При только один процесс в Oouistiti VMSize составляет около 26 м .

Страница производительности дает больше информации об использовании памяти.

Время

Ouistiti - это не веб -сервер для большой сети, но он получает хорошие результаты для доставки документа. Выступления зависят от конфигурации сборки, и вам нужно.

• Чтобы получить наилучшие результаты, OuistiTi должен быть построен без управления потоками (vthread = n).
• Чтобы получить максимальную безопасность, OuistiTi должен быть построен с одним процессом на каждого клиента (vhtread = y и vthread_type = fork).

OUISTITI может быть быстрее, чем LightTPD 1.4, но без всех функций. Вы можете найти некоторые результаты тестирования на странице производительности.