Класс Oauth

Стратегия аутентификации Oauth 1 для Cake\Http\Client

Этот объект не обрабатывает получение токенов доступа Oauth от поставщика услуг. Он только обрабатывает запросы к клиенту после того, как вы получили токены Oauth.

Обычно не создается напрямую, а используется Cake\Http\Client, когда $options['auth']['type'] равен 'oauth'

Пространство имен: Cake\Http\Client\Auth

Краткое описание методов

_buildAuth() защищенный

Создает значение заголовка авторизации Oauth.
_encode() защищенный

Кодирует значение в соответствии с правилами rfc3986.
_hmacSha1() защищенный

Использование подписи HMAC-SHA1.
_normalizeData() защищенный

Рекурсивно преобразует данные запроса в нормализованную форму.
_normalizedParams() защищенный

Сортирует и нормализует данные запроса и oauthValues.
_normalizedUrl() защищенный

Создает нормализованный URL.
_plaintext() защищенный

Подпись в открытом виде.
_rsaSha1() защищенный

Использование подписи RSA-SHA1.
authentication() публичный

Добавляет заголовки для авторизации Oauth.
baseString() публичный

Генерирует базовую строку Oauth.

Подробное описание методов

_buildAuth() защищенный

_buildAuth(array $data): string

Создает значение заголовка авторизации Oauth.

Параметры

array $data: Значения oauth_* для создания.

Возвращает

string

_encode() защищенный

_encode(string $value): string

Кодирует значение в соответствии с правилами rfc3986.

Параметры

string $value: Значение для кодирования.

Возвращает

string

_hmacSha1() защищенный

_hmacSha1(Cake\Http\Client\Request $request, array $credentials): string

Использование подписи HMAC-SHA1.

Этот метод подходит для обычного HTTP или HTTPS.

Параметры

Cake\Http\Client\Request $request: Объект запроса.
array $credentials: Данные аутентификации.

Возвращает

string

_normalizeData() защищенный

_normalizeData(array $args, string $path = ''): array

Рекурсивно преобразует данные запроса в нормализованную форму.

Параметры

array $args: Аргументы для нормализации.
string $path необязательно: Текущий путь, преобразуемый в данный момент.

Возвращает

array

См. также

https://tools.ietf.org/html/rfc5849#section-3.4.1.3.2

_normalizedParams() защищенный

_normalizedParams(Cake\Http\Client\Request $request, array $oauthValues): string

Сортирует и нормализует данные запроса и oauthValues.

Раздел 9.1.1 спецификации Oauth.

Кодирует URL ключей и значений.
Сортирует ключи и значения по байтовому значению.

Параметры

Cake\Http\Client\Request $request: Объект запроса.
array $oauthValues: Значения Oauth.

Возвращает

string

_normalizedUrl() защищенный

_normalizedUrl(Psr\Http\Message\UriInterface $uri): string

Создает нормализованный URL.

Раздел 9.1.2 спецификации Oauth.

Параметры

Psr\Http\Message\UriInterface $uri: Объект Uri для создания нормализованной версии.

Возвращает

string

_plaintext() защищенный

_plaintext(Cake\Http\Client\Request $request, array $credentials): string

Подпись в открытом виде.

Этот метод не подходит для обычного HTTP. Вы должны использовать только PLAINTEXT при работе с SSL-сервисами.

Параметры

Cake\Http\Client\Request $request: Объект запроса.
array $credentials: Данные аутентификации.

Возвращает

string

_rsaSha1() защищенный

_rsaSha1(Cake\Http\Client\Request $request, array $credentials): string

Использование подписи RSA-SHA1.

Этот метод подходит для обычного HTTP или HTTPS.

Параметры

Cake\Http\Client\Request $request: Объект запроса.
array $credentials: Данные аутентификации.

Возвращает

string

Выбрасывает

RuntimeException

authentication() публичный

authentication(Cake\Http\Client\Request $request, array $credentials): Cake\Http\Client\Request

Добавляет заголовки для авторизации Oauth.

Параметры

Cake\Http\Client\Request $request: Объект запроса.
array $credentials: Данные аутентификации.

Возвращает

Cake\Http\Client\Request

Выбрасывает

Cake\Core\Exception\CakeException
При неверном типе подписи.

baseString() публичный

baseString(Cake\Http\Client\Request $request, array $oauthValues): string

Генерирует базовую строку Oauth.

Комбинируются значения параметров запроса, данных запроса и oauth_*.
Значения сортируются по имени, а затем значению.
Значения запроса конкатенируются и кодируются в URL.
URL запроса (без строки запроса) нормализуется.
Конкатенируются HTTP-метод, URL и параметры запроса, и возвращается результат.

Параметры

Cake\Http\Client\Request $request: Объект запроса.
array $oauthValues: Значения Oauth.

Возвращает

string

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Http.Client.Auth.Oauth.html