Class yii\authclient\signature\RsaSha

Inheritanceyii\authclient\signature\RsaSha » yii\authclient\signature\BaseMethod » yii\base\BaseObject
Subclassesyii\authclient\signature\RsaSha1
Available since version2.1.3

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
$privateCertificateFile string Path to the file, which holds private key certificate. 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

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
initPrivateCertificate() Creates initial value for \yii\authclient\signature\privateCertificate. yii\authclient\signature\RsaSha
initPublicCertificate() Creates initial value for \yii\authclient\signature\publicCertificate. 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
$privateCertificateFile public property

Path to the file, which holds private key certificate.

$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

public void init ( )
initPrivateCertificate() protected method

Creates initial value for \yii\authclient\signature\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 \yii\authclient\signature\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.