Class yii\authclient\signature\RsaSha1

All Classes | Properties | Methods

Inheritance	yii\authclient\signature\RsaSha1 » yii\authclient\signature\BaseMethod » yii\base\Object
Available since extension's 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).

Public Properties

Hide inherited properties

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
$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

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By

Public Methods

Hide inherited methods

Method	Description	Defined By
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
init()		yii\authclient\signature\RsaSha1
setPrivateCertificate()		yii\authclient\signature\RsaSha1
setPublicCertificate()		yii\authclient\signature\RsaSha1
verify()	Verifies given OAuth request.	yii\authclient\signature\RsaSha1

Protected Methods

Hide inherited methods

Method	Description	Defined By
initPrivateCertificate()	Creates initial value for $privateCertificate.	yii\authclient\signature\RsaSha1
initPublicCertificate()	Creates initial value for $publicCertificate.	yii\authclient\signature\RsaSha1

Property Details

Hide inherited properties

$_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

$privateCertificate public property

Private key certificate content.

public string $privateCertificate = null

$privateCertificateFile public property

Path to the file, which holds private key certificate.

public string $privateCertificateFile = ''

$publicCertificate public property

Public key certificate content.

public string $publicCertificate = null

$publicCertificateFile public property

Path to the file, which holds public key certificate.

public string $publicCertificateFile = ''

Method Details

Hide inherited methods

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.

Source code

                public function generateSignature($baseString, $key)
{
    $privateCertificateContent = $this->getPrivateCertificate();
    // Pull the private key ID from the certificate
    $privateKeyId = openssl_pkey_get_private($privateCertificateContent);
    // Sign using the key
    openssl_sign($baseString, $signature, $privateKeyId);
    // Release the key resource
    openssl_free_key($privateKeyId);
    return base64_encode($signature);
}

getName() public method

Return the canonical name of the Signature Method.

public string getName ( )
return	string	Method name.

Source code

                public function getName()
{
    return 'RSA-SHA1';
}

getPrivateCertificate() public method

public string getPrivateCertificate ( )
return	string	Private key certificate content.

Source code

                public function getPrivateCertificate()
{
    if ($this->_privateCertificate === null) {
        $this->_privateCertificate = $this->initPrivateCertificate();
    }
    return $this->_privateCertificate;
}

getPublicCertificate() public method

public string getPublicCertificate ( )
return	string	Public key certificate content.

Source code

                public function getPublicCertificate()
{
    if ($this->_publicCertificate === null) {
        $this->_publicCertificate = $this->initPublicCertificate();
    }
    return $this->_publicCertificate;
}

init() public method

public void init ( )

Source code

                public function init()
{
    if (!function_exists('openssl_sign')) {
        throw new NotSupportedException('PHP "OpenSSL" extension is required.');
    }
}

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.

Source code

                protected function initPrivateCertificate()
{
    if (!empty($this->privateCertificateFile)) {
        if (!file_exists($this->privateCertificateFile)) {
            throw new InvalidConfigException("Private certificate file '{$this->privateCertificateFile}' does not exist!");
        }
        return file_get_contents($this->privateCertificateFile);
    } else {
        return '';
    }
}

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.

Source code

                protected function initPublicCertificate()
{
    if (!empty($this->publicCertificateFile)) {
        if (!file_exists($this->publicCertificateFile)) {
            throw new InvalidConfigException("Public certificate file '{$this->publicCertificateFile}' does not exist!");
        }
        return file_get_contents($this->publicCertificateFile);
    } else {
        return '';
    }
}

setPrivateCertificate() public method

public void setPrivateCertificate ( $privateCertificate )
$privateCertificate	string	Private key certificate content.

Source code

                public function setPrivateCertificate($privateCertificate)
{
    $this->_privateCertificate = $privateCertificate;
}

setPublicCertificate() public method

public void setPublicCertificate ( $publicCertificate )
$publicCertificate	string	Public key certificate content.

Source code

                public function setPublicCertificate($publicCertificate)
{
    $this->_publicCertificate = $publicCertificate;
}

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.

Source code

                public function verify($signature, $baseString, $key)
{
    $decodedSignature = base64_decode($signature);
    // Fetch the public key cert based on the request
    $publicCertificate = $this->getPublicCertificate();
    // Pull the public key ID from the certificate
    $publicKeyId = openssl_pkey_get_public($publicCertificate);
    // Check the computed signature against the one passed in the query
    $verificationResult = openssl_verify($baseString, $decodedSignature, $publicKeyId);
    // Release the key resource
    openssl_free_key($publicKeyId);
    return ($verificationResult == 1);
}