HumHub Documentation (unofficial)

RsaSha extends BaseMethod
in package

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).

Tags
author

Paul Klimov klimov.paul@gmail.com

since
2.1.3

Table of Contents

Properties

$algorithm  : int|string
$privateCertificate  : string
$privateCertificateFile  : string
$publicCertificate  : string
$publicCertificateFile  : string
$_privateCertificate  : string
$_publicCertificate  : string

Methods

__call()  : mixed
Calls the named method which is not a class method.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of an object property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets value of an object property.
__unset()  : mixed
Sets an object property to null.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
generateSignature()  : string
Generates OAuth request signature.
getName()  : string
Return the canonical name of the Signature Method.
getPrivateCertificate()  : string
getPublicCertificate()  : string
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined.
init()  : mixed
Initializes the object.
setPrivateCertificate()  : mixed
setPublicCertificate()  : mixed
verify()  : bool
Verifies given OAuth request.
initPrivateCertificate()  : string
Creates initial value for [[privateCertificate]].
initPublicCertificate()  : string
Creates initial value for [[publicCertificate]].

Properties

$privateCertificate

public string $privateCertificate

Private key certificate content.

$privateCertificateFile

public string $privateCertificateFile

path to the file, which holds private key certificate.

$publicCertificate

public string $publicCertificate

Public key certificate content.

$publicCertificateFile

public string $publicCertificateFile

path to the file, which holds public key certificate.

$_privateCertificate

protected string $_privateCertificate

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

$_publicCertificate

protected string $_publicCertificate

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

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

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.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

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.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.

public __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
Return values
mixed —

the property value

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

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.

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set (not null).

__set()

Sets value of an object property.

public __set(string $name, mixed $value) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__unset()

Sets an object property to null.

public __unset(string $name) : mixed

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.

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ]) : bool

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);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ]) : bool

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);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

generateSignature()

Generates OAuth request signature.

public generateSignature(mixed $baseString, mixed $key) : string
Parameters
$baseString : mixed

signature base string.

$key : mixed

signature key.

Return values
string —

signature string.

getName()

Return the canonical name of the Signature Method.

public getName() : string
Return values
string —

method name.

getPrivateCertificate()

public getPrivateCertificate() : string
Return values
string —

private key certificate content.

getPublicCertificate()

public getPublicCertificate() : string
Return values
string —

public key certificate content.

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters
$name : string

the method name

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.

public hasProperty(string $name[, bool $checkVars = true ]) : bool

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);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed

setPrivateCertificate()

public setPrivateCertificate(string $privateCertificate) : mixed
Parameters
$privateCertificate : string

private key certificate content.

setPublicCertificate()

public setPublicCertificate(string $publicCertificate) : mixed
Parameters
$publicCertificate : string

public key certificate content.

verify()

Verifies given OAuth request.

public verify(mixed $signature, mixed $baseString, mixed $key) : bool
Parameters
$signature : mixed

signature to be verified.

$baseString : mixed

signature base string.

$key : mixed

signature key.

Return values
bool —

success.

initPrivateCertificate()

Creates initial value for [[privateCertificate]].

protected initPrivateCertificate() : string

This method will attempt to fetch the certificate value from [[privateCertificateFile]] file.

Tags
throws
InvalidConfigException

on failure.

Return values
string —

private certificate content.

initPublicCertificate()

Creates initial value for [[publicCertificate]].

protected initPublicCertificate() : string

This method will attempt to fetch the certificate value from [[publicCertificateFile]] file.

Tags
throws
InvalidConfigException

on failure.

Return values
string —

public certificate content.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results