Spec-Zone.ru › CakePHP 3.6

Класс 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() защищённый
    Строит значение заголовка авторизации Oauth.
  • _encode() защищённый
    Кодирует значение в URL по правилам rfc3986
  • _hmacSha1() защищённый
    Использует подпись HMAC-SHA1.
  • _normalizeData() защищённый
    Рекурсивно преобразует данные запроса в нормализованную форму.
  • _normalizedParams() защищённый
    Сортирует и нормализует данные запроса и значения oauth
  • _normalizedUrl() защищённый
    Строит нормализованный URL
  • _plaintext() защищённый
    Подпись в открытом виде
  • _rsaSha1() защищённый
    Использует подпись RSA-SHA1.
  • authentication() общедоступный
    Добавляет заголовки для авторизации Oauth.
  • baseString() общедоступный
    Генерирует базовую строку Oauth

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

_buildAuth()source защищённый

_buildAuth( array $data )

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

Параметры

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

Возвращает

строка

_encode()source защищённый

_encode( string $value )

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

Параметры

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

Возвращает

строка

_hmacSha1()source защищённый

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

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

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

Параметры

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

Возвращает

строка

_normalizeData()source защищённый

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

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

Параметры

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

Возвращает

массив

См. также

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

_normalizedParams()source защищённый

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

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

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

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

Параметры

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

Возвращает

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

_normalizedUrl()source защищённый

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

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

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

Параметры

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

Возвращает

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

_plaintext()source защищённый

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

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

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

Параметры

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

Возвращает

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

_rsaSha1()source защищённый

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

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

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

Параметры

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

Возвращает

строка

Исключения

RuntimeException

authentication()source общедоступный

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 общедоступный

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

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

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

Параметры

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

Возвращает

строка

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API