Класс yii\authclient\signature\RsaSha
| Наследование | yii\authclient\signature\RsaSha » yii\authclient\signature\BaseMethod » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Подклассы | yii\authclient\signature\RsaSha1 |
| Доступна с версии | 2.1.3 |
| Исходный код | https://github.com/yiisoft/yii2-authclient/blob/master/signature/RsaSha.php |
RsaSha1 представляет метод подписи 'SHAwithRSA' (также известен как RSASSA-PKCS1-V1_5-SIGN с хешем SHA).
Примечание: Для этого класса требуется расширение PHP "OpenSSL"(http://php.net/manual/en/book.openssl.php).
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $algorithm | целое число|строка | Алгоритм хеширования подписи, например, OPENSSL_ALGO_SHA1, OPENSSL_ALGO_SHA256 и так далее. | yii\authclient\signature\RsaSha |
| $name | строка | Имя метода. | yii\authclient\signature\RsaSha |
| $privateCertificate | строка | Контент сертификата закрытого ключа. | yii\authclient\signature\RsaSha |
| $privateCertificateFile | строка | Путь к файлу, содержащему сертификат закрытого ключа. | yii\authclient\signature\RsaSha |
| $publicCertificate | строка | Контент сертификата открытого ключа. | yii\authclient\signature\RsaSha |
| $publicCertificateFile | строка | Путь к файлу, содержащему сертификат открытого ключа. | yii\authclient\signature\RsaSha |
Защищенные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $_privateCertificate | строка | Контент сертификата закрытого ключа OpenSSL. | yii\authclient\signature\RsaSha |
| $_publicCertificate | строка | Контент сертификата открытого ключа OpenSSL. | yii\authclient\signature\RsaSha |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т. е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| generateSignature() | Генерирует подпись запроса OAuth. | yii\authclient\signature\RsaSha |
| getName() | Возвращает каноническое имя метода подписи. | yii\authclient\signature\RsaSha |
| getPrivateCertificate() | yii\authclient\signature\RsaSha | |
| getPublicCertificate() | yii\authclient\signature\RsaSha | |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\authclient\signature\RsaSha |
| setPrivateCertificate() | yii\authclient\signature\RsaSha | |
| setPublicCertificate() | yii\authclient\signature\RsaSha | |
| verify() | Проверяет заданный запрос OAuth. | yii\authclient\signature\RsaSha |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| initPrivateCertificate() | Создает начальное значение для $privateCertificate. | yii\authclient\signature\RsaSha |
| initPublicCertificate() | Создает начальное значение для $publicCertificate. | yii\authclient\signature\RsaSha |
Подробное описание свойств
$_privateCertificate защищенное свойство
Контент сертификата закрытого ключа OpenSSL. Это значение можно получить из файла, указанного в $privateCertificateFile.
protected string $_privateCertificate = null
$_publicCertificate защищенное свойство
Контент сертификата открытого ключа OpenSSL. Это значение можно получить из файла, указанного в $publicCertificateFile.
protected string $_publicCertificate = null
$algorithm публичное свойство
Алгоритм хеширования подписи, например, OPENSSL_ALGO_SHA1, OPENSSL_ALGO_SHA256 и так далее.
См. также http://php.net/manual/en/openssl.signature-algos.php.
public integer|string $algorithm = null
$name публичное только для чтения свойство
Имя метода.
public string getName ( )
$privateCertificate публичное свойство
Контент сертификата закрытого ключа.
public string getPrivateCertificate ( )
public void setPrivateCertificate ( $privateCertificate )
$privateCertificateFile публичное свойство
Путь к файлу, содержащему сертификат закрытого ключа.
public string $privateCertificateFile = null
$publicCertificate публичное свойство
Контент сертификата открытого ключа.
public string getPublicCertificate ( )
public void setPublicCertificate ( $publicCertificate )
$publicCertificateFile общественное свойство
Путь к файлу, содержащему сертификат открытого ключа.
public string $publicCertificateFile = null
Подробное описание методов
generateSignature() общественный метод
Генерирует подпись запроса OAuth.
| общественный строка generateSignature ( $baseString, $key ) | ||
|---|---|---|
| $baseString | строка |
Строка основания подписи. |
| $key | строка |
Ключ подписи. |
| возвращаемое значение | строка |
Строка подписи. |
getName() общественный метод
Возвращает каноническое имя метода подписи.
| общественный строка getName ( ) | ||
|---|---|---|
| возвращаемое значение | строка |
Имя метода. |
getPrivateCertificate() общественный метод
| общественный строка getPrivateCertificate ( ) | ||
|---|---|---|
| возвращаемое значение | строка |
Содержимое сертификата закрытого ключа. |
getPublicCertificate() общественный метод
| общественный строка getPublicCertificate ( ) | ||
|---|---|---|
| возвращаемое значение | строка |
Содержимое сертификата открытого ключа. |
init() общественный метод
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| общественный void init ( ) |
|---|
initPrivateCertificate() защищённый метод
Создаёт начальное значение для $privateCertificate.
Этот метод попытается извлечь значение сертификата из файла $privateCertificateFile.
| защищённый строка initPrivateCertificate ( ) | ||
|---|---|---|
| возвращаемое значение | строка |
Содержимое сертификата закрытого ключа. |
| выбрасывает | yii\base\InvalidConfigException |
при ошибке. |
initPublicCertificate() защищённый метод
Создаёт начальное значение для $publicCertificate.
Этот метод попытается извлечь значение сертификата из файла $publicCertificateFile.
| защищённый строка initPublicCertificate ( ) | ||
|---|---|---|
| возвращаемое значение | строка |
Содержимое сертификата открытого ключа. |
| выбрасывает | yii\base\InvalidConfigException |
при ошибке. |
setPrivateCertificate() общественный метод
| общественный void setPrivateCertificate ( $privateCertificate ) | ||
|---|---|---|
| $privateCertificate | строка |
Содержимое сертификата закрытого ключа. |
setPublicCertificate() общественный метод
| общественный void setPublicCertificate ( $publicCertificate ) | ||
|---|---|---|
| $publicCertificate | строка |
Содержимое сертификата открытого ключа. |
verify() общественный метод
Проверяет данный запрос OAuth.
| общественный логический тип verify ( $signature, $baseString, $key ) | ||
|---|---|---|
| $signature | строка |
Подпись для проверки. |
| $baseString | строка |
Строка основания подписи. |
| $key | строка |
Ключ подписи. |
| возвращаемое значение | логический тип |
Успех. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-signature-rsasha.html