IMSGlobal\LTI\OAuth\OAuthSignatureMethod Class Reference

Class to represent an OAuth Signature Method. More...

Inheritance diagram for IMSGlobal\LTI\OAuth\OAuthSignatureMethod:

Collaboration diagram for IMSGlobal\LTI\OAuth\OAuthSignatureMethod:

Public Member Functions
	get_name ()
	Needs to return the name of the Signature Method (ie HMAC-SHA1) More...
	build_signature ($request, $consumer, $token)
	Build up the signature NOTE: The output of this function MUST NOT be urlencoded. More...
	check_signature ($request, $consumer, $token, $signature)
	Verifies that a given signature is correct. More...

Detailed Description

Class to represent an OAuth Signature Method.

Copyright

Andy Smith

Version

2008-08-04 https://opensource.org/licenses/MIT The MIT License A class for implementing a Signature Method See section 9 ("Signing Requests") in the spec

Definition at line 16 of file OAuthSignatureMethod.php.

Member Function Documentation

build_signature()

IMSGlobal\LTI\OAuth\OAuthSignatureMethod::build_signature (   $request,   $consumer,   $token  )

abstract

Build up the signature NOTE: The output of this function MUST NOT be urlencoded.

the encoding is handled in OAuthRequest when the final request is serialized

Parameters

OAuthRequest	$request
OAuthConsumer	$consumer
OAuthToken	$token

Returns

string

Referenced by IMSGlobal\LTI\OAuth\OAuthSignatureMethod\check_signature().

Here is the caller graph for this function:

check_signature()

IMSGlobal\LTI\OAuth\OAuthSignatureMethod::check_signature	(		$request,
			$consumer,
			$token,
			$signature
	)

Verifies that a given signature is correct.

Parameters

OAuthRequest	$request
OAuthConsumer	$consumer
OAuthToken	$token
string	$signature

Returns

bool

Definition at line 43 of file OAuthSignatureMethod.php.

References $consumer, $i, $result, and IMSGlobal\LTI\OAuth\OAuthSignatureMethod\build_signature().

                                                                             {

        $built = $this->build_signature($request, $consumer, $token);

        // Check for zero length, although unlikely here
        if (strlen($built) == 0 || strlen($signature) == 0) {
            return false;
        }

        if (strlen($built) != strlen($signature)) {
            return false;
        }

        // Avoid a timing leak with a (hopefully) time insensitive compare
        $result = 0;
        for ($i = 0; $i < strlen($signature); $i++) {
            $result |= ord($built{$i}) ^ ord($signature{$i});
        }

        return $result == 0;

    }

Here is the call graph for this function:

get_name()

IMSGlobal\LTI\OAuth\OAuthSignatureMethod::get_name ( )

abstract

Needs to return the name of the Signature Method (ie HMAC-SHA1)

Returns

string

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/imsglobal/lti/src/OAuth/OAuthSignatureMethod.php