ssh2_auth_pubkey — Аутентифицирует клиента по открытому ключу в переменной

Назначение ssh2_auth_pubkey

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

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

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

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

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

Сигнатура ssh2_auth_pubkey

Структурная запись: bool ssh2_auth_pubkey(resource $session, string $username, string $pubkey, string $privkey, string $passphrase = значение по умолчанию). В ней 5 параметров: обязательные $session, $username, $pubkey, $privkey; необязательные $passphrase. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры ssh2_auth_pubkey

Порядок и роли аргументов по сигнатуре: 1. $session — resource, обязателен; 2. $username — string, обязателен; 3. $pubkey — string, обязателен; 4. $privkey — string, обязателен; 5. $passphrase — string, необязателен.

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

1) resource $session — обязательный: подтвердите тип и открытое состояние ресурса, затем проверьте вызов после его закрытия. 2) string $username — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 3) string $pubkey — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 4) string $privkey — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 5) string $passphrase — необязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной.

Результат ssh2_auth_pubkey

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

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

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

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

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

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

Сначала запишите точную сигнатуру bool ssh2_auth_pubkey(resource $session, string $username, string $pubkey, string $privkey, string $passphrase = значение по умолчанию) и фактические типы переданных значений. Затем подтвердите загрузку расширения «ssh2» в той же среде, где выполняется ssh2_auth_pubkey. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

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

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

Для ssh2_auth_pubkey базовый ориентир: аутентифицирует клиента по открытому ключу в переменной; обязательные $session, $username, $pubkey, $privkey; необязательные $passphrase; результат bool. Сопоставление с опубликованными соседями: ssh2_auth_pubkey_file: аутентифицирует клиента путём считывания открытого ключа из файла; вход — обязательные $session, $username, $pubkeyfile, $privkeyfile; необязательные $passphrase; результат — bool. ssh2_auth_agent: аутентификация через ssh с помощью агент ssh; вход — обязательные $session, $username; результат — bool. ssh2_auth_hostbased_file: аутентификация с использованием открытого ключа хоста; вход — обязательные $session, $username, $hostname, $pubkeyfile, $privkeyfile; необязательные $passphrase, $local_username; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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