SQL-выборки журнала запросов переписаны на штатное D7 ORM — устранён риск SQL-инъекции через поля фильтра и значение токена.
IP клиента определяется только по REMOTE_ADDR — подделка заголовков X-Forwarded-For / Client-IP больше не влияет на лимиты запросов и журнал.
Токены и уникальные коды теперь генерируются криптостойко (random_int / random_bytes вместо rand и md5); ранее выданные токены остаются рабочими.
При удалении пользователя идентификатор приводится к целому числу.
Демонстрационный контроллер больше не возвращает полный массив $_SERVER.
В заголовки ответа добавлена очистка переводов строки (защита от подмены HTTP-заголовков).
Для нативного провайдера добавлен контроль доступа к вызываемым классам и методам. По умолчанию действует чёрный список опасных операций (произвольный SQL, файловые операции и заливка файлов, управление пользователями и группами, внешние HTTP-запросы, рассылки и т.п.) — обычные read-вызовы не затронуты. Дополнительно поддерживается режим белого списка: перекрыв роут своим классом, можно разрешить только нужные классы и методы.
На роуты управления токеном (создание, получение, удаление) добавлена защита от перебора учётных данных — при превышении лимита неудачных попыток с одного IP возвращается ответ 429.
При создании пользователя через API системные поля (группы, токен, служебные атрибуты) больше нельзя задать напрямую — защита от mass assignment и повышения привилегий. Набором полей можно управлять чёрным и белым списком, перекрыв роут своим классом.
Административный AJAX генерации токенов теперь требует авторизации в админке, прав на раздел «Безопасность» и защищён от CSRF — массовая генерация токенов внешним запросом больше невозможна.
Код поля токена из настроек проверяется как корректный идентификатор перед подстановкой в SQL — устранён риск инъекции через административную настройку.
Исправлено получение значений параметров. Причина: после обновления платформы, названия параметров приводились к нижнему регистру.
Обновлена ссылка на Документацию в меню модуля.
Доработано описание параметра Отложенный запуск.
4.18.0
04.01.2026
Тип
Описание
Техническое обновление.
Улучшена поддержка версии PHP выше 8.1.
Релизы: 2024
4.17.0
30.06.2024
Тип
Описание
Добавлена поддержка отключения передачи данных ответа при использовании json(). Например: response()->json(null, 404);
Добавлена проверка существования пути при установке пути к собственным картам роутов.
Добавлена возможность дополнять заголовок Access-Control-Allow-Headers. Смотрите раздел: Безопасность - Фильтры.
4.16.0
02.03.2024
Тип
Описание
Улучшено определение кастомных заголовков Content-Type (+json) при выполнении запросов к модулю.
Релизы: 2023
4.15.0
18.11.2023
Тип
Описание
Добавлена возможность указывать кастомные заголовки Content-Type (+json) при выполнении запросов к модулю. Например: Content-Type: application/vnd.eda.picker.errors.v1+json или application/problem+json, и так далее. Подробнее: https://www.iana.org/assignments/media-types/media-types.xhtml
Добавлена возможность передачи собственного ID клиента в функцию journal()->add().
Добавлены функции-полифилы для корректной работы модуля на версии PHP меньше 8.0: str_contains, str_starts_with, str_ends_with.
4.14.0
22.07.2023
Тип
Описание
Добавлена возможность указывать собственный заголовок Content-Type при ответе клиенту. Внимание: при проверке используется функция str_contains, которая доступна только с версии PHP 8.0.
4.13.2
31.05.2023
Тип
Описание
Улучшена совместимость с PHP 8 и выше.
4.13.1
19.05.2023
Тип
Описание
Обновлена ссылка на документацию к модулю.
4.13.0
05.05.2023
Тип
Описание
Поправлена логика проверки входных параметров.
4.12.0
22.02.2023
Тип
Описание
Улучшена совместимость с PHP 8 и выше.
4.11.0
13.01.2023
Тип
Описание
Улучшена совместимость с PHP 8 и выше.
Релизы: 2022
4.10.0
30.08.2022
Тип
Описание
На уровне ядра добавлен заголовок Access-Control-Allow-Credentials со значением true.
Отключена проверка модуля безопасности на фишинг при редиректе на страницу документации из административного раздела.
4.9.0
02.08.2022
Тип
Описание
Работа с журналом Входящие запросы - переведено на штатное ORM.
Повышена производительность Монитора поддержки.
Доработана вёрстка Монитора поддержки.
Рефакторинг и оптимизация.
Релизы: 2021
4.8.1
19.07.2021
Тип
Описание
Добавлена обратная совместимость для старых версий модуля, где еще отсутствует класс Password с методом equals().
Мелкие правки.
4.8.0
03.07.2021
Тип
Описание
В новых версиях главного модуля, поле PASSWORD объявлено приватным. Поэтому, при авторизаци по логину и паролю, могли наблюдаться проблемы.
Незначительные улучшения.
4.7.0
02.06.2021
Тип
Описание
Теперь учитывается формат даты и времени для не RU локализаций.
Кодировка копирайта в заголовке ответа.
Мелкие правки и рефакторинг.
Релизы: 2020
4.6.0
19.12.2020
Тип
Описание
Добавлена возможность выбора сайтов, на которых необходимо запускать модуль.
Улучшена работа модуля в режиме многосайтовости.
Добавлено игнорирование всех запросов, которые выполняются на адрес /bitrix/.
4.5.0
03.12.2020
Тип
Описание
Авторизация по логину и паролю. Теперь проверка пароля выполняется с помощью метода Bitrix\Main\Security\Password::equals().
В связи с устаревшим, начиная с версии PHP 7.2.0, функционалом механизма перегрузки функций (mbstring.func_overload), и отказом от использования его в платформе, строковые функции модуля были переведны в многобайтовый режим работы.
Проблема при подключении модуля в файле init.php, в случае, если файл имелся в директории, но был абсолютно пустым.
Теперь резервная копия файла init.php создаётся до установки и до удаления модуля. Ранее копия создавалась лишь при установке модуля.
Незначительные технические изменения.
4.4.0
17.10.2020
Тип
Описание
Авторизация по логину и паролю.
Функция возврата ответа клиенту: response()->json(). Теперь в данную функцию можно передавать значения заголовков не только в виде строки, но и в виде массива. В котором могут быть указаны дополнительные параметры для заголовка (в соответствии с функцией header($header, $replace, $http_response_code)). Подробнее смотрите в роуте-примере (example).
Класс Artamonov\Rest\Foundation\Token. Теперь можно генерировать токены пользователей с помощью данного класса, при любой необходимости. Класс поддерживает как генерацию токенов, так и другие действия. Генерация токенов возможна для списка пользователей, плюс поддерживаются параметры ($parameters) от метода UserTable::getList(). Для удобства добавлена функция token(). Подробнее смотрите в документации.
В разделе Безопасность, пошаговое создание и обновление токенов для пользователей. Полезная функция, если в базе сайта зарегистрировано большое количество пользователей.
Незначительные технические изменения.
4.3.1
18.09.2020
Тип
Описание
Техническое обновление.
4.3.0
11.09.2020
Тип
Описание
Проблема возникающая после истечения демонстрационного периода.
4.2.0
06.09.2020
Тип
Описание
Метод получения параметров модуля из базы. Теперь получаемые параметры кэшируются. Время кэширования зависит от настроек параметра cache_flags в файле /bitrix/.settings.php.
Метод получения данных пользователя, если была активна авторизация для роута. Теперь метод умеет десериализовывать данные в пользовательских полях.
Ключ карты роутов example был добавлен в роуте {api}/docs.
Если в карте роутов отсутствует какой-либо контроллер (файл или класс), тогда в документации будет выведено сообщение об этом.
Параметр для регулирования глобальной проверки сроков годности токенов. Внимание: по умолчанию данный параметр отключен. Подробнее в разделе Безопасность.
Автогенерация токена при добавлении нового пользователя. Подробнее в разделе Безопасность.
Сообщения возвращаемые клиенту при возникновении ошибок на этапе запуска интерфейса.
4.1.0
10.08.2020
Тип
Описание
Проверка многоуровневых параметров при передаче запроса. Подробнее структуру карты можно посмотреть в документации к модулю.
Раздел документации с картой роутов - теперь поддерживается отображение неограниченного количества уровней параметров роута.
Поддержка разделителя параметров в документации карты роутов - для лучшего визуального представления списка параметров. Подробнее структуру карты можно посмотреть в примере карты роутов.
При проверке параметра на integer, в опции max_range теперь используется константа PHP_INT_MAX.
Теперь числа переданные в виде строки, будут автоматически преобразованы в нужный тип, при проверке входящих параметров. Поддерживаемые типы для преобразования: integer, float.
4.0.2
07.07.2020
Тип
Описание
Верстка в разделе Документация - Карта роутов.
4.0.1
22.05.2020
Тип
Описание
Проверка типа входящих параметров.
4.0.0
22.04.2020
Тип
Описание
Настройка видимости меню модуля в общем меню админ. раздела.
Нативный роут {{api}}/provider. Роут является провайдером к внутреннему апи платформы 1С-Битрикс. Поддерживает get и post запросы. Подробнее про использование роута можно узнать в документации.
3.5.0
15.01.2020
Тип
Описание
В Helper модуля добавлен метод isBool.
Техническое обновление.
Релизы: 2019
3.4.0
26.10.2019
Тип
Описание
Возможность использовать переменные в роутах. Теперь в карте роутов можно указывать шаблон строки с использованием переменных. Например: /example/check/section/{{sectionId}}/{{productId}}/view/. Значения переменных sectionId и productId можно будет получить так же через request()->get(). Примеры шаблонов строк можно посмотреть в документации по картам роутов.
Константы отключающие сбор статистики, проверки агентов и другие.
Мелкие правки по дизайну модуля в админ.разделе.
Мелкие правки по коду.
3.3.2
31.08.2019
Тип
Описание
Решена проблема отображения роутов в документации, если контроллеры роутов были прописаны через путь к файлу, а не через неймспейс.
3.3.1
30.07.2019
Тип
Описание
Решена проблема отображения технического сообщения на страницах Настройки и Безопасность при активации режима "Установка для разработки".
3.3.0
24.06.2019
Тип
Описание
Отложенный запуск интерфейса. Теперь можно регулировать момент запуска модуля с помощью параметра в Настройках. Стало возможным запускать модуль либо при старте init.php (1.5), либо перед запуском визуальной части, в событии OnProlog (1.15). Подробнее: https://dev.1c-bitrix.ru/api_help/main/general/pageplan.php
Документация.
3.2.0
07.05.2019
Тип
Описание
Техническое обновление.
3.1.0
16.02.2019
Тип
Описание
Для большего удобства документация по модулю вынесена на сторонний ресурс.
Документация по модулю.
Мелкие улучшения.
3.0.0
15.02.2019
Тип
Описание
Метод создания таблиц журналов.
Языковые фразы.
2.9.3
09.02.2019
Тип
Описание
Выборка данных по дате в журнале Входящие запросы.
Ошибка возникающая в случае удаления таблиц при удалении модуля.
2.9.2
09.02.2019
Тип
Описание
Логика внутренних функций.
2.9.1
09.02.2019
Тип
Описание
Незначительные ошибки.
2.9.0
09.02.2019
Тип
Описание
Если роут отключен, тогда он будет исключен из документации в публичной части (см. описание версии 2.5.0).
Теперь функции модуля не доступны из публичной части сайта.
Оптимизация и увеличение производительности.
2.8.0
08.02.2019
Тип
Описание
В Журнал Запрос/Ответ добавлено поле Метод, а также добавлен фильтр по данному полю.
При авторизации через логин и пароль теперь еще происходит проверка на наличие $_SERVER['PHP_AUTH_USER'] и $_SERVER['PHP_AUTH_PW'], для поддержки HTTP Authorization.
При несовпадении типа контента запроса с настройками роута, теперь возвращается название типа контента, который необходим при запросе.
Если запрос производится с участием авторизации, через токен или логин/пароль, тогда в параметры запроса будет добавлена информация о пользователе, которому принадлежат авторизационные данные. Данные пользователя сохраняются в ключ _user. Напоминание: в контроллере, параметры входящего запроса, можно получить с помощью функции request()->get().
При отключении нативных роутов они деактивируются и в документации.
Добавлен индикатор активности нативных роутов в раздел Поддержка.
Расширена поддержка типов контента при запросе. Например, ранее, метод PUT или DELETE поддерживали только application/json, теперь поддерживают и application/x-www-form-urlencoded, и другие. Напоминание: не забывайте указывать/ограничивать тип контента запроса через карту роутов, с помощью ключа contentType.
Расширена поддержка типов запросов: HEAD, PATCH.
Название Журнала Запрос/Ответ -> Входящие запросы.
Актуализирована документация по модулю.
Описание модуля из раздела Документация - Основные сведения.
Незначительные исправления.
2.7.0
01.02.2019
Тип
Описание
Приведение названий входящих заголовков к нижнему регистру.
Нативный роут для получения ID пользователя по логину или токену. При запросе требуется авторизация по токену. Уточнение: любой роут может быть перекрыт через собственную карту роутов. То есть, если нативный роут вам чем-то не подходит, то вы можете скопировать его в собственную карту и модифицировать под необходимую логику.
Возможность включать/отключать использование нативных роутов.
Возможность указывать путь к собственным картам роутов. Теперь, нет необходимости хранить рабочие файлы в папке модуля. А именно, карты роутов и контроллеры. Напоминаем о том, что контроллером для роута может выступать, как класс доступный по неймспейсу, так и обычный скрипт. Которые могут располагаться за пределами директории модуля.
lang-папки для языков: en, de, fr. Внимание, все фразы имеют русский перевод. Папки добавлены для корректной работы модуля на мультиязычных сайтах.
2.6.0
13.01.2019
Тип
Описание
Добавлен параметр Срок годности токена. Теперь можно указывать срок годности токена при его генерации.
В карте роутов, в секции security, в ключ token, добавлен ключ checkExpire, регулирующий необходимость проверки срока годности токена, при авторизации через токен.
В карте роутов, в секции security, ключ authType переименован в type, и перенесен в ключ auth.
2.5.0
13.01.2019
Тип
Описание
Добавлен встроенный роут /{api}/docs для получения документации в публичной части. Теперь клиенты могут получать автоматически генерируемую документацию в JSON-формате, которая создается на основе карт роутов.
Папка {module_id}/lib/controllers/example/ удалена, а класс Example перенесен в {module_id}/lib/controllers/native/.
2.4.0
12.01.2019
Тип
Описание
Возможность управлять CORS (кросс-доменными запросами) из административного раздела сайта.
2.3.0
12.01.2019
Тип
Описание
Вернули поддержку файлового режима работы. Теперь в карте роута, вместо контроллера, можно указать путь к php-скрипту. Подробнее смотрите в карте-примере: /routes/_example.php.
2.2.0
12.01.2019
Тип
Описание
Функция json_encode заменена на Bitrix\Main\Web\Json::encode для принудительного кодирования ответа в utf-8.
Заголовки модуля отсылаются только в том случае, если был запущен интерфейс.
В карте роутов, в секции security, убран ключ required.
Возможность авторизации по логину/паролю. Тип авторизации настраивается в карте роута - ключ authType - подробнее смотрите в карте-примере: /routes/_example.php.
Все настройки и функционал присущий авторизации через токен, так же действует и для авторизации через логин/пароль.
2.1.1
11.01.2019
Тип
Описание
Добавлен принудительный перевод в нижний регистр названия класса при его автоматическом подключении
2.1.0
10.01.2019
Тип
Описание
В карту роутов, в секцию security, добавлен ключ required, который указывает на необходимость активации параметра Авторизация по токену. Подробнее смотрите в карте-примере: /routes/_example.php
2.0.0
05.01.2019
Тип
Описание
Отключение использования функции GetModuleID, так как из-за неё возникала проблема в работе модуля на windows-серверах, в виду разности разделителей директорий ("/", "\"). Проблема описана в Отзыве.
Увеличен размер поля IP в таблице artamonov_rest_request_response. Для избежания проблемы, когда запросы посылаются из REST-клиентов.
Добавлены роуты для работы с токенами (создание, получение, удаление).
Добавлены роуты для работы с пользователями (создание, получение, обновление, удаление).
Небольшая оптимизация и ускорение работы ядра.
Релизы: 2018
1.2.0
11.11.2018
Тип
Описание
Добавлена возможность передавать сообщение при ответе badRequest, internalServerError.
Добавлена валидация входящих параметров при запросе. Происходит проверка на наличие параметра в запросе, а также на соответствие типу. Валидация параметров реализована на два уровня. Поддерживаемые типы параметров при валидации: string, integer, float, email, ip, domain, url. Подробнее смотрите в карте роутов.
Добавлены человеко-понятные ответы при неудачных запросах типа badRequest.
Проблема при получении GET-параметров при запросах типа PUT и DELETE.
Проблема при получении заголовков запроса на Nginx (без Apache).
Стили модуля в административном разделе сайта.
1.1.0
24.10.2018
Тип
Описание
Языковые фразы.
Условие при установке кэша для избежания получения Исключения.
Добавлен параметр в разделе Настройки для включения/отключения тестового роута - http|https://{domain}/{api}/example/check.
В карте роутов добавлен ключ possibleValue, для указания возможных значений параметра запроса. Подробнее смотрите в карте роутов.
В карте роутов добавлена возможность добавлять пример ответа на запрос. Подробнее смотрите в карте роутов.
В карте роутов добавлена возможность исключать описание роута. Подробнее смотрите в карте роутов.