Класс Oauth

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

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

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

Пространство имён: Cake\Http\Client\Auth
Расположение: Http/Client/Auth/Oauth.php

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

_buildAuth() protected
Строит значение заголовка авторизации Oauth.
_encode() protected
Кодирует значение по правилам rfc3986
_hmacSha1() protected
Использование подписи HMAC-SHA1.
_normalizedParams() protected
Сортирует и нормализует данные запроса и oauthValues
_normalizedUrl() protected
Строит нормализованный URL
_plaintext() protected
Подпись в виде простого текста
_rsaSha1() protected
Использование подписи RSA-SHA1.
authentication() public
Добавление заголовков для авторизации Oauth.
baseString() public
Генерация базовой строки Oauth

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

_buildAuth()source protected

_buildAuth( array $data )

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

Параметры

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

Возвращает

строка

_encode()source protected

_encode( string $value )

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

Параметры

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

Возвращает

строка

_hmacSha1()source protected

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

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

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

Параметры

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

Возвращает

строка

_normalizedParams()source protected

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

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

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

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

Параметры

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

Возвращает

строка
отсортированные и нормализованные значения

_normalizedUrl()source protected

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

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

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

Параметры

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

Возвращает

строка
Нормализованный URL

_plaintext()source protected

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

Подпись в виде простого текста

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

Параметры

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

Возвращает

строка
Заголовок авторизации.

_rsaSha1()source protected

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

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

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

Параметры

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

Возвращает

строка

Исключения

RuntimeException

authentication()source public

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

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

Параметры

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

Возвращает

Cake\Http\Client\Request
Обновлённый запрос.

Исключения

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

baseString()source public

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

Генерация базовой строки Oauth

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

Параметры

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

Возвращает

строка

© 2005–2017 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/3.3/class-Cake.Http.Client.Auth.Oauth.html