ssh2_publickey_add — Добавляет авторизованный открытый ключ

Назначение ssh2_publickey_add

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

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

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

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

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

Сигнатура ssh2_publickey_add

Структурная запись: bool ssh2_publickey_add(resource $pkey, string $algoname, string $blob, bool $overwrite = false, array $attributes = значение по умолчанию). В ней 5 параметров: обязательные $pkey, $algoname, $blob; необязательные $overwrite, $attributes. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры ssh2_publickey_add

Порядок и роли аргументов по сигнатуре: 1. $pkey — resource, обязателен; 2. $algoname — string, обязателен; 3. $blob — string, обязателен; 4. $overwrite — bool, необязателен, default false; 5. $attributes — array, необязателен.

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

1) resource $pkey — обязательный: подтвердите тип и открытое состояние ресурса, затем проверьте вызов после его закрытия. 2) string $algoname — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 3) string $blob — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 4) bool $overwrite — необязательный: передайте true и false явно, не полагаясь на нестрогое приведение скалярных значений. 5) array $attributes — необязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений.

Результат ssh2_publickey_add

ssh2_publickey_add объявляет результат типа bool. ssh2_publickey_add возвращает логическое значение. Назовите ветви успеха и отказа явно и сохраните контекст входных данных для диагностики отрицательного результата.

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

Убедитесь, что раздел «ssh2» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором resource $pkey, string $algoname, string $blob. Затем отдельно добавьте необязательные параметры bool $overwrite=false, array $attributes, чтобы увидеть влияние значений по умолчанию. Для профиля «безопасность» важно не записывать секреты и исходные ключи в журнал; негативный сценарий должен проверить неверный ключ, повреждённые данные и отказ операции.

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

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

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

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

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

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

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

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

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

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

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

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

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