Class yii\authclient\signature\RsaSha

Inheritanceyii\authclient\signature\RsaSha » yii\authclient\signature\BaseMethod » yii\base\BaseObject
Implementsyii\base\Configurable
Subclassesyii\authclient\signature\RsaSha1
Available since version2.1.3
Source Code https://github.com/yiisoft/yii2-authclient/blob/master/signature/RsaSha.php

RsaSha1 represents 'SHAwithRSA' (also known as RSASSA-PKCS1-V1_5-SIGN with the SHA hash) signature method.

Note: This class requires PHP "OpenSSL" extension(http://php.net/manual/en/book.openssl.php).

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$algorithm integer|string Signature hash algorithm, e.g. OPENSSL_ALGO_SHA1, OPENSSL_ALGO_SHA256 and so on. yii\authclient\signature\RsaSha
$name string Method name. yii\authclient\signature\RsaSha
$privateCertificate string Private key certificate content. yii\authclient\signature\RsaSha
$privateCertificateFile string Path to the file, which holds private key certificate. yii\authclient\signature\RsaSha
$publicCertificate string Public key certificate content. yii\authclient\signature\RsaSha
$publicCertificateFile string Path to the file, which holds public key certificate. yii\authclient\signature\RsaSha

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$_privateCertificate string OpenSSL private key certificate content. yii\authclient\signature\RsaSha
$_publicCertificate string OpenSSL public key certificate content. yii\authclient\signature\RsaSha

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
generateSignature() Generates OAuth request signature. yii\authclient\signature\RsaSha
getName() Return the canonical name of the Signature Method. yii\authclient\signature\RsaSha
getPrivateCertificate() yii\authclient\signature\RsaSha
getPublicCertificate() yii\authclient\signature\RsaSha
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\authclient\signature\RsaSha
setPrivateCertificate() yii\authclient\signature\RsaSha
setPublicCertificate() yii\authclient\signature\RsaSha
verify() Verifies given OAuth request. yii\authclient\signature\RsaSha

Property Details

$_privateCertificate protected property

OpenSSL private key certificate content. This value can be fetched from file specified by $privateCertificateFile.

protected string $_privateCertificate null
$_publicCertificate protected property

OpenSSL public key certificate content. This value can be fetched from file specified by $publicCertificateFile.

protected string $_publicCertificate null
$algorithm public property

Signature hash algorithm, e.g. OPENSSL_ALGO_SHA1, OPENSSL_ALGO_SHA256 and so on.

See also http://php.net/manual/en/openssl.signature-algos.php.

public integer|string $algorithm null
$name public read-only property

Method name.

public string getName ( )
$privateCertificate public property

Private key certificate content.

public string getPrivateCertificate ( )
public void setPrivateCertificate ( $privateCertificate )
$privateCertificateFile public property

Path to the file, which holds private key certificate.

$publicCertificate public property

Public key certificate content.

public string getPublicCertificate ( )
public void setPublicCertificate ( $publicCertificate )
$publicCertificateFile public property

Path to the file, which holds public key certificate.

Method Details

generateSignature() public method

Generates OAuth request signature.

public string generateSignature ( $baseString, $key )
$baseString string

Signature base string.

$key string

Signature key.

return string

Signature string.

getName() public method

Return the canonical name of the Signature Method.

public string getName ( )
return string

Method name.

getPrivateCertificate() public method

public string getPrivateCertificate ( )
return string

Private key certificate content.

getPublicCertificate() public method

public string getPublicCertificate ( )
return string

Public key certificate content.

init() public method

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 ( )
initPrivateCertificate() protected method

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.

initPublicCertificate() protected method

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.

setPrivateCertificate() public method

public void setPrivateCertificate ( $privateCertificate )
$privateCertificate string

Private key certificate content.

setPublicCertificate() public method

public void setPublicCertificate ( $publicCertificate )
$publicCertificate string

Public key certificate content.

verify() public method

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.