ssh2_publickey_list — Список уже авторизованных открытых ключей

Назначение ssh2_publickey_list

ssh2_publickey_list: Список уже авторизованных открытых ключей. Справочная сущность относится к разделу «ssh2». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается ssh2_publickey_list

Это процедурная функция раздела «ssh2». Её отличают имя ssh2_publickey_list, контракт «обязательные $pkey» и объявленный результат array; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление ssh2_publickey_list

Смысловое направление ssh2_publickey_list — «получение данных». В прикладном коде различайте отсутствие данных, пустое значение и технический отказ источника. Контрольный набор для этой операции: проверьте пустой источник, один результат и недоступное окружение. Такой акцент отделяет ssh2_publickey_list от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура ssh2_publickey_list

Структурная запись: array ssh2_publickey_list(resource $pkey). В ней 1 параметр: обязательные $pkey. Результат объявлен как array; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры ssh2_publickey_list

Порядок и роли аргументов по сигнатуре: 1. $pkey — resource, обязателен. Для ssh2_publickey_list фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

Контроль входных данных для ssh2_publickey_list

1) resource $pkey — обязательный: подтвердите тип и открытое состояние ресурса, затем проверьте вызов после его закрытия.

Результат ssh2_publickey_list

ssh2_publickey_list объявляет результат типа array. ssh2_publickey_list возвращает коллекцию типа array. Пустой набор может быть корректным результатом, поэтому его смысл определяют отдельно от исключения или диагностического сообщения.

Проверочный сценарий для ssh2_publickey_list

Убедитесь, что раздел «ssh2» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором resource $pkey. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «безопасность» важно не записывать секреты и исходные ключи в журнал; негативный сценарий должен проверить неверный ключ, повреждённые данные и отказ операции.

Интеграция ssh2_publickey_list в проект

Проверку доступности ssh2_publickey_list и преобразование входных значений разместите у границы модуля «ssh2». Для профиля «безопасность» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция ssh2_publickey_list не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика ssh2_publickey_list

Сначала запишите точную сигнатуру array ssh2_publickey_list(resource $pkey) и фактические типы переданных значений. Затем подтвердите загрузку расширения «ssh2» в той же среде, где выполняется ssh2_publickey_list. Если результат неожиданен, сравните его тип с array и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «безопасность» применяйте отдельный негативный тест: проверить неверный ключ, повреждённые данные и отказ операции. В production-коде важно не записывать секреты и исходные ключи в журнал. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать ssh2_publickey_list

Выбор ssh2_publickey_list оправдан, когда одновременно выполнены три условия: 1) в сборке доступно расширение «ssh2»; 2) сигнатура содержит 1 аргумент: обязательных 1, необязательных 0; 3) вызывающему коду нужен результат array и действие «получение данных». Для профиля «безопасность» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с ssh2_publickey_init: у него другое назначение, владелец или набор входных данных.

Сравнение ssh2_publickey_list с соседними API

Для ssh2_publickey_list базовый ориентир: список уже авторизованных открытых ключей; обязательные $pkey; результат array. Сопоставление с опубликованными соседями: ssh2_publickey_init: инициализирует подсистему открытого ключа; вход — обязательные $session; результат — resource|false. ssh2_publickey_add: добавляет авторизованный открытый ключ; вход — обязательные $pkey, $algoname, $blob; необязательные $overwrite, $attributes; результат — bool. ssh2_publickey_remove: удаляет авторизованный открытый ключ; вход — обязательные $pkey, $algoname, $blob; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

ssh2_publickey_list сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для ssh2_publickey_list.

Связанные материалы