Класс Oauth

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

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

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

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

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

_buildAuth() protected

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

Кодирует значение в URL согласно правилам rfc3986.
_hmacSha1() protected

Использует подпись HMAC-SHA1.
_normalizeData() protected

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

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

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

Подпись с открытым текстом.
_rsaSha1() protected

Использует подпись RSA-SHA1.
authentication() public

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

Генерирует строку Oauth.
checkSslError() protected

Проверяет наличие ошибок SSL и генерирует исключение, если они обнаружены.

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

_buildAuth() protected

_buildAuth(array $data): string

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

Параметры

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

Возвращает

string

_encode() protected

_encode(string $value): string

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

Параметры

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

Возвращает

string

_hmacSha1() protected

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

Использует подпись HMAC-SHA1.

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

Параметры

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

Возвращает

string

_normalizeData() protected

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

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

Параметры

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

Возвращает

array

См. также

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

_normalizedParams() protected

_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() protected

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

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

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

Параметры

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

Возвращает

string

_plaintext() protected

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

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

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

Параметры

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

Возвращает

string

_rsaSha1() protected

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

Использует подпись RSA-SHA1.

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

Параметры

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

Возвращает

string

Вызывает исключение

RuntimeException

authentication() public

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() public

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

Генерирует строку Oauth.

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

Параметры

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

Возвращает

string

checkSslError() protected

checkSslError(): void

Проверяет наличие ошибок SSL и генерирует исключение, если они обнаружены.

Возвращает

void

© 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.3/class-Cake.Http.Client.Auth.Oauth.html