enlightn
v2.10.0
Думайте о Enlightn как о вашем консультанте по производительности и безопасности. Onlightn «просматривает» конфигурации кода и сервера и даст вам действенные рекомендации по повышению производительности, безопасности и надежности!
Версия Enlightn OSS (программное обеспечение с открытым исходным кодом) имеет 66 автоматических проверок, которые сканируют код вашего приложения, конфигурации и маршруты веб -сервера для определения узких мест производительности, возможных уязвимостей безопасности и проблем с надежностью кода.
Onlightn Pro (Commercial) доступен для покупки на веб -сайте onlightn и имеет дополнительные 64 автоматизированных чеков (всего 131 чек ).
Каждый из 131 доступных чеков хорошо задокументирован. Вы можете найти полную документацию здесь.
| Просвет | Ларавел | Ларастан | Phpstan |
|---|---|---|---|
| 1.x | 6.x-9.x | 0,6x-1.x | 0,12x-1,1x |
| 2.x. | 9.x-11.x | 2.x. | 1,4x+ |
ПРИМЕЧАНИЕ. Та же самая матрица совместимости применяется для версий onlightn Pro.
Вы можете установить onlightn в свой проект, используя диспетчер пакетов Composer:
composer require enlightn/enlightnПосле установки onlightn вы можете опубликовать его активы, используя поставщик: публикация Artisan Command:
php artisan vendor:publish --tag=enlightnПримечание. Если вам нужно установить onlightn Pro, посетите документацию на веб -сайте onlightn здесь.
После установки onlightn просто запустите команду enlightn Artisan, чтобы запустить onlightn:
php artisan enlightn Вы можете добавить флаг --report вы хотите просмотреть свои отчеты в пользовательском интерфейсе onlightn Web, кроме терминала:
php artisan enlightn --reportЕсли вы хотите провести конкретные классы анализатора, вы можете указать их как необязательные аргументы:
php artisan enlightn Enlightn \ Enlightn \ Analyzers \ Security \ CSRFAnalyzer Enlightn \ EnlightnPro \ Analyzers \ Security \ DirectoryTraversalAnalyzerОбратите внимание, что имена классов должны быть полностью квалифицированы и сбежать с двойными чертами, как указано выше.
Если вы хотите получить полный опыт Enlightn, рекомендуется, чтобы вы хотя бы запустили Enlightn один раз в производстве. Это связано с тем, что некоторые из чеков Enlightn являются специфичными для окружающей среды. Таким образом, они могут быть вызваны только тогда, когда в вашей среде приложения является производство.
Если вы не хотите работать на производстве, вы можете моделировать производственную среду, установив свой APP_ENV для производства, настраивая услуги и конфигурацию как можно ближе к производству и запустив свой сценарий развертывания производства локально. Затем запустите команду Enlightn Artisan.
По умолчанию команда enlightn Artisan выделяет пути файла, связанные номера строк и сообщение для каждой неудачной проверки. Если вы хотите отобразить подробные сообщения об ошибках для каждой строки, вы можете использовать опцию --details :
php artisan enlightn --details Если вы хотите интегрировать Enlightn с вашим CI, вы можете просто запустить опцию --ci при запуске Enlightn в вашем инструменте CI/CD:
php artisan enlightn --ci Вы можете добавить флаг --report если вы хотите просмотреть свои отчеты CI в пользовательском интерфейсе onlightn. Не забудьте добавить учетные данные своего проекта в ваш файл config/enlightn.php как описано здесь.
php artisan enlightn --ci --reportПредварительные конфигурации Enlightn, которые анализаторы могут быть запускаются в режиме CI для вас. Таким образом, вышеупомянутая команда исключает анализаторов, которым нужна полная настройка для запуска (например, анализаторы с использованием динамического анализа).
Для получения дополнительной информации о интеграции CI, обратитесь к документации Enlightn.
Иногда, особенно в средах CI, вы можете объявить в настоящее время сообщаемый список ошибок как «базовый уровень». Это означает, что текущие ошибки не будут сообщены в последующих пробегах, и будут помечены только новые ошибки.
Чтобы автоматически генерировать базовую линию, вы можете запустить команду enlightn:baseline Artisan:
php artisan enlightn:baseline Если вы хотите запустить эту команду в режиме CI, вы можете использовать опцию --ci :
php artisan enlightn:baseline --ciДля получения дополнительной информации о создании базовой линии, обратитесь к документам.
Enlightn предлагает красивую панель пользовательского интерфейса, где вы можете просмотреть свои отчеты onlightn, запускаемые из ваших CI или запланированных команд.
Интернет -интерфейс бесплатный для всех пользователей и включает в себя следующее:
Чтобы получить доступ к веб -пользовательскому интерфейсу, все, что вам нужно сделать, это подписать бесплатно на веб -сайте onlightn и следовать указаниям, упомянутым здесь.
Помимо интеграции Enlightn с вашим инструментом CI/CD, это хорошая практика, чтобы запланировать программу, запускающуюся на регулярной частоте (например, ежедневную или еженедельную), как SO:
// In your app/Console/Kernel.php file:
/**
* Define the application's command schedule.
*
* @param IlluminateConsoleSchedulingSchedule $schedule
* @return void
*/
protected function schedule ( Schedule $ schedule )
{
$ schedule -> command ( ' enlightn --report ' )-> runInBackground ()-> daily ()-> at ( ' 01:00 ' );
}Это позволит вам отслеживать динамические проверки анализа Enlightn, которые обычно исключаются из CI. Отчеты можно просматривать в пользовательском интерфейсе onlightn Web.
Enlightn предлагает бот Github, который может подготовить отчет, выделяющий неудачные проверки, а также добавить комментарии к просмотру за запросами на линии кода, которые вводят новые проблемы.
Чтобы интегрироваться с ботом onlightn github, обратитесь к документам.
Все проверки, которые сняты, будут включать описание того, почему они не удались вместе с соответствующими линиями кода (если применимо) и ссылку на документацию для конкретной проверки.
Наконец, после того, как все проверки пройдут, команда enlightn Artisan выведет табель успеваемости, которая содержит информацию о том, сколько и какой процент чеков проходил, не удалось или были пропущены.
Проверки, указанные как «не применимые», не были применимы к вашему конкретному приложению и были пропущены. Например, анализатор CSRF не применим к приложениям без сохранения состояния.
Проверки, представленные в строке «Ошибка», указывают на анализаторы, которые не удались за исключением во время анализа. Обычно этого не должно произойти, но если это произойдет, связанное сообщение об ошибке будет отображаться и может иметь какое -то отношение к вашему приложению.
Хорошей практикой было бы запуск onlightn каждый раз, когда вы развертываете код или выдвигаете новый релиз. Рекомендуется интегрировать onlightn с вашим инструментом CI/CD, чтобы он был запускается для каждого толчка или нового выпуска.
Помимо автоматизированных проверок CI, вы также должны запустить onlightn на обычной частоте, используя запланированную консольную команду, как описано выше. Это позволит вам отслеживать проверки динамического анализа, которые обычно исключаются из CI.
Для Enlightn поддерживаются только системы macOS и Linux. Windows в настоящее время не поддерживается.
Спасибо за рассмотрение внесения вклад в Enlightn! Руководство по взносу можно найти здесь.
Наша политика поддержки может быть найдена в документации Enlightn.
Enlightn OSS (в этом репозитории GitHub) лицензируется по лицензии LGPL V3 (или более поздней).
Onlightn Pro имеет лицензию по коммерческой лицензии.
