Class yii\authclient\signature\RsaSha
Inheritance | yii\authclient\signature\RsaSha » yii\authclient\signature\BaseMethod » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable |
Subclasses | yii\authclient\signature\RsaSha1 |
Available since version | 2.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(https://php.net/manual/en/book.openssl.php).
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$_privateCertificate | string | OpenSSL private key certificate content. | yii\authclient\signature\RsaSha |
$_publicCertificate | string | OpenSSL public key certificate content. | yii\authclient\signature\RsaSha |
$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 |
Public Methods
Method | Description | Defined 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 |
Protected Methods
Method | Description | Defined By |
---|---|---|
initPrivateCertificate() | Creates initial value for $privateCertificate. | yii\authclient\signature\RsaSha |
initPublicCertificate() | Creates initial value for $publicCertificate. | yii\authclient\signature\RsaSha |
Property Details
OpenSSL private key certificate content. This value can be fetched from file specified by $privateCertificateFile.
OpenSSL public key certificate content. This value can be fetched from file specified by $publicCertificateFile.
Signature hash algorithm, e.g. OPENSSL_ALGO_SHA1
, OPENSSL_ALGO_SHA256
and so on.
See also https://php.net/manual/en/openssl.signature-algos.php.
Private key certificate content.
Path to the file, which holds private key certificate.
Public key certificate content.
Path to the file, which holds public key certificate.
Method Details
Defined in: yii\base\BaseObject::__call()
Calls the named method which is not a class method.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
public mixed __call ( $name, $params ) | ||
$name | string |
The method name |
$params | array |
Method parameters |
return | mixed |
The method return value |
---|---|---|
throws | yii\base\UnknownMethodException |
when calling unknown method |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
Defined in: yii\base\BaseObject::__construct()
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config
. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$config
here. - call the parent implementation at the end of the constructor.
public void __construct ( $config = [] ) | ||
$config | array |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in: yii\base\BaseObject::__get()
Returns the value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $object->property;
.
See also __set().
public mixed __get ( $name ) | ||
$name | string |
The property name |
return | mixed |
The property value |
---|---|---|
throws | yii\base\UnknownPropertyException |
if the property is not defined |
throws | yii\base\InvalidCallException |
if the property is write-only |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\BaseObject::__isset()
Checks if a property is set, i.e. defined and not null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($object->property)
.
Note that if the property is not defined, false will be returned.
public boolean __isset ( $name ) | ||
$name | string |
The property name or the event name |
return | boolean |
Whether the named property is set (not null). |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
Defined in: yii\base\BaseObject::__set()
Sets value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $object->property = $value;
.
See also __get().
public void __set ( $name, $value ) | ||
$name | string |
The property name or the event name |
$value | mixed |
The property value |
throws | yii\base\UnknownPropertyException |
if the property is not defined |
---|---|---|
throws | yii\base\InvalidCallException |
if the property is read-only |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
Defined in: yii\base\BaseObject::__unset()
Sets an object property to null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($object->property)
.
Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.
public void __unset ( $name ) | ||
$name | string |
The property name |
throws | yii\base\InvalidCallException |
if the property is read only. |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
Defined in: yii\base\BaseObject::canGetProperty()
Returns a value indicating whether a property can be read.
A property is readable if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true);
See also canSetProperty().
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
return | boolean |
Whether the property can be read |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
Defined in: yii\base\BaseObject::canSetProperty()
Returns a value indicating whether a property can be set.
A property is writable if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true);
See also canGetProperty().
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
return | boolean |
Whether the property can be written |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class
instead.
Defined in: yii\base\BaseObject::className()
Returns the fully qualified name of this class.
public static string className ( ) | ||
return | string |
The fully qualified name of this class. |
---|
public static function className()
{
return get_called_class();
}
Generates OAuth request signature.
public string generateSignature ( $baseString, $key ) | ||
$baseString | string |
Signature base string. |
$key | string |
Signature key. |
return | string |
Signature string. |
---|
public function generateSignature($baseString, $key)
{
$privateCertificateContent = $this->getPrivateCertificate();
// Pull the private key ID from the certificate
$privateKeyId = openssl_pkey_get_private($privateCertificateContent, $key);
// Sign using the key
openssl_sign($baseString, $signature, $privateKeyId, $this->algorithm);
if (\PHP_VERSION_ID < 80000) {
// Release the key resource. Done automatically in PHP 8
openssl_free_key($privateKeyId);
}
return base64_encode($signature);
}
Return the canonical name of the Signature Method.
public string getName ( ) | ||
return | string |
Method name. |
---|
public function getName()
{
if (is_int($this->algorithm)) {
$constants = get_defined_constants(true);
if (isset($constants['openssl'])) {
foreach ($constants['openssl'] as $name => $value) {
if (strpos($name, 'OPENSSL_ALGO_') !== 0) {
continue;
}
if ($value === $this->algorithm) {
$algorithmName = substr($name, strlen('OPENSSL_ALGO_'));
break;
}
}
}
if (!isset($algorithmName)) {
throw new InvalidConfigException("Unable to determine name of algorithm '{$this->algorithm}'");
}
} else {
$algorithmName = strtoupper($this->algorithm);
}
return 'RSA-' . $algorithmName;
}
public string getPrivateCertificate ( ) | ||
return | string |
Private key certificate content. |
---|
public function getPrivateCertificate()
{
if ($this->_privateCertificate === null) {
$this->_privateCertificate = $this->initPrivateCertificate();
}
return $this->_privateCertificate;
}
public string getPublicCertificate ( ) | ||
return | string |
Public key certificate content. |
---|
public function getPublicCertificate()
{
if ($this->_publicCertificate === null) {
$this->_publicCertificate = $this->initPublicCertificate();
}
return $this->_publicCertificate;
}
Defined in: yii\base\BaseObject::hasMethod()
Returns a value indicating whether a method is defined.
The default implementation is a call to php function method_exists()
.
You may override this method when you implemented the php magic method __call()
.
public boolean hasMethod ( $name ) | ||
$name | string |
The method name |
return | boolean |
Whether the method is defined |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
Defined in: yii\base\BaseObject::hasProperty()
Returns a value indicating whether a property is defined.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true);
See also:
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
return | boolean |
Whether the property is defined |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
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 ( ) |
public function init()
{
if (!function_exists('openssl_sign')) {
throw new NotSupportedException('PHP "OpenSSL" extension is required.');
}
}
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. |
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);
}
return '';
}
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. |
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);
}
return '';
}
public void setPrivateCertificate ( $privateCertificate ) | ||
$privateCertificate | string |
Private key certificate content. |
public function setPrivateCertificate($privateCertificate)
{
$this->_privateCertificate = $privateCertificate;
}
public void setPublicCertificate ( $publicCertificate ) | ||
$publicCertificate | string |
Public key certificate content. |
public function setPublicCertificate($publicCertificate)
{
$this->_publicCertificate = $publicCertificate;
}
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. |
---|
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, $this->algorithm);
if (\PHP_VERSION_ID < 80000) {
// Release the key resource. Done automatically in PHP 8
openssl_free_key($publicKeyId);
}
return ($verificationResult == 1);
}