Функции могут быть вызваны как UseModule("Security")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| GetSecretContract | Получение контракта системного хранилища секретов
 Подробнее...
Возвращает JSON-контракт системного хранилища секретов модуля Security: поддерживаемые области, типы сущностей, правила безопасной выдачи и границы ответственности с другими модулями. | Отсутствуют |
| GetSecretMetadata | Получение метаданных секрета
Подробнее...
Возвращает безопасные метаданные секрета без расшифровки и выдачи значения: статус, версию, fingerprint, назначение, потребителей и сроки ротации. | | Тип | Параметр | По умолчанию | Описание | | String|Array | $reference | Обязательный | Ссылка на секрет. |
|
| HealthCheckSecretsDefinition | Диагностика хранилища секретов Security
Подробнее...
Проверяет системный JSON-контракт, доступность каталога хранилища, наличие криптографии, структуру файла секретов и отсутствие открытых значений в диагностируемых данных. | | Тип | Параметр | По умолчанию | Описание | | Array | $options | Обязательный | Параметры диагностики. Для текущего среза используются только стандартные проверки без раскрытия секретов. |
|
| ListSecretReferences | Список ссылок на секреты
Подробнее...
Возвращает список зарегистрированных секретов с безопасными метаданными. Значения секретов, зашифрованные payload и audit с внутренними деталями не выдаются. | | Тип | Параметр | По умолчанию | Описание | | Array | $filter | Обязательный | Фильтр списка: scope, ownerModule, status, consumer, tag. |
|
| MaskSecretPayload | Маскирование секретных данных
Подробнее...
Маскирует секретные значения в строках, массивах и объектах перед выводом в UI, лог, audit или диагностический отчет. | | Тип | Параметр | По умолчанию | Описание | | Mixed | $value | Обязательный | Строка, массив или объект, в котором необходимо скрыть секретные значения. | | Array | $options | Обязательный | Параметры маскирования. maskScalars=true маскирует одиночную строку как значение секрета. |
|
| NormalizeSecretReference | Нормализация ссылки на секрет
Подробнее...
Проверяет и приводит ссылку на секрет к каноническому виду secret://scope/name. Функция не читает и не возвращает значение секрета. | | Тип | Параметр | По умолчанию | Описание | | String|Array | $reference | Обязательный | Ссылка на секрет в виде строки secret://scope/name, scope/name, name или массива scope/name/ref. | | Array | $defaults | Обязательный | Значения по умолчанию: scope, ownerModule и другие служебные атрибуты нормализации. |
|
| ResolveSecretReference | Разрешение ссылки на секрет
Подробнее...
Находит секрет по ссылке и возвращает его безопасное описание. Само значение выдается только при явном параметре includeValue и проверке consumer binding. | | Тип | Параметр | По умолчанию | Описание | | String|Array | $reference | Обязательный | Ссылка на секрет. | | Array | $options | Обязательный | Параметры разрешения: includeValue, consumer. Без includeValue значение секрета не возвращается. |
|
| RotateSecret | Ротация секрета
Подробнее...
Создает или заменяет значение секрета в системном хранилище Security. Значение шифруется на диске, в ответе не возвращается и в audit сохраняется только как маска и fingerprint. | | Тип | Параметр | По умолчанию | Описание | | String|Array | $reference | Обязательный | Ссылка на секрет: secret://scope/name, scope/name, name или массив с полями scope/name/ref. | | String | $value | Обязательный | Новое значение секрета. Пустое значение запрещено, если явно не указан allowEmpty. | | Array | $options | Обязательный | Параметры ротации: dryRun, allowEmpty, ownerModule, purpose, consumers, tags, rotationPolicy, expiresAt. |
|