Класс 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
Кодирует значение в 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

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

_buildAuth()source protected

_buildAuth( array $data )

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

Параметры

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

Возвращает

строка

_encode()source protected

_encode( string $value )

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

Параметры

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

Возвращает

строка

_hmacSha1()source protected

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

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

Этот метод подходит для простого HTTP или HTTPS.

Параметры

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

Возвращает

строка

_normalizeData()source protected

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

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

Параметры

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

Возвращает

массив

См. также

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

_normalizedParams()source protected

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

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

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

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

Параметры

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