Inheritance | yii\authclient\signature\RsaSha1 » yii\authclient\signature\BaseMethod » yii\base\Object |
---|---|
Implements | yii\base\Configurable |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-authclient/blob/master/signature/RsaSha1.php |
RsaSha1 represents 'RSA-SHA1' signature method.
Note: This class requires PHP "OpenSSL" extension(http://php.net/manual/en/book.openssl.php).
Property | Type | Description | Defined By |
---|---|---|---|
$name | string | Method name. | yii\authclient\signature\RsaSha1 |
$privateCertificate | string | Private key certificate content. | yii\authclient\signature\RsaSha1 |
$privateCertificateFile | string | Path to the file, which holds private key certificate. | yii\authclient\signature\RsaSha1 |
$publicCertificate | string | Public key certificate content. | yii\authclient\signature\RsaSha1 |
$publicCertificateFile | string | Path to the file, which holds public key certificate. | yii\authclient\signature\RsaSha1 |
Property | Type | Description | Defined By |
---|---|---|---|
$_privateCertificate | string | OpenSSL private key certificate content. | yii\authclient\signature\RsaSha1 |
$_publicCertificate | string | OpenSSL public key certificate content. | yii\authclient\signature\RsaSha1 |
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\Object |
__construct() | Constructor. | yii\base\Object |
__get() | Returns the value of an object property. | yii\base\Object |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
__set() | Sets value of an object property. | yii\base\Object |
__unset() | Sets an object property to null. | yii\base\Object |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Object |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
className() | Returns the fully qualified name of this class. | yii\base\Object |
generateSignature() | Generates OAuth request signature. | yii\authclient\signature\RsaSha1 |
getName() | Return the canonical name of the Signature Method. | yii\authclient\signature\RsaSha1 |
getPrivateCertificate() | yii\authclient\signature\RsaSha1 | |
getPublicCertificate() | yii\authclient\signature\RsaSha1 | |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Object |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
init() | Initializes the object. | yii\authclient\signature\RsaSha1 |
setPrivateCertificate() | yii\authclient\signature\RsaSha1 | |
setPublicCertificate() | yii\authclient\signature\RsaSha1 | |
verify() | Verifies given OAuth request. | yii\authclient\signature\RsaSha1 |
Method | Description | Defined By |
---|---|---|
initPrivateCertificate() | Creates initial value for $privateCertificate. | yii\authclient\signature\RsaSha1 |
initPublicCertificate() | Creates initial value for $publicCertificate. | yii\authclient\signature\RsaSha1 |
OpenSSL private key certificate content. This value can be fetched from file specified by $privateCertificateFile.
protected string $_privateCertificate = null
OpenSSL public key certificate content. This value can be fetched from file specified by $publicCertificateFile.
protected string $_publicCertificate = null
Method name.
public string getName ( )
Private key certificate content.
public string getPrivateCertificate ( )
public void setPrivateCertificate ( $privateCertificate )
Path to the file, which holds private key certificate.
public string $privateCertificateFile = ''
Public key certificate content.
public string getPublicCertificate ( )
public void setPublicCertificate ( $publicCertificate )
Path to the file, which holds public key certificate.
public string $publicCertificateFile = ''
Generates OAuth request signature.
public string generateSignature ( $baseString, $key ) | ||
---|---|---|
$baseString | string |
Signature base string. |
$key | string |
Signature key. |
return | string |
Signature string. |
Return the canonical name of the Signature Method.
public string getName ( ) | ||
---|---|---|
return | string |
Method name. |
public string getPrivateCertificate ( ) | ||
---|---|---|
return | string |
Private key certificate content. |
public string getPublicCertificate ( ) | ||
---|---|---|
return | string |
Public key certificate content. |
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
public void init ( ) |
---|
Creates initial value for $privateCertificate.
This method will attempt to fetch the certificate value from $privateCertificateFile file.
protected string initPrivateCertificate ( ) | ||
---|---|---|
return | string |
Private certificate content. |
throws | yii\base\InvalidConfigException |
on failure. |
Creates initial value for $publicCertificate.
This method will attempt to fetch the certificate value from $publicCertificateFile file.
protected string initPublicCertificate ( ) | ||
---|---|---|
return | string |
Public certificate content. |
throws | yii\base\InvalidConfigException |
on failure. |
public void setPrivateCertificate ( $privateCertificate ) | ||
---|---|---|
$privateCertificate | string |
Private key certificate content. |
public void setPublicCertificate ( $publicCertificate ) | ||
---|---|---|
$publicCertificate | string |
Public key certificate content. |
Verifies given OAuth request.
public boolean verify ( $signature, $baseString, $key ) | ||
---|---|---|
$signature | string |
Signature to be verified. |
$baseString | string |
Signature base string. |
$key | string |
Signature key. |
return | boolean |
Success. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-signature-rsasha1.html