OAuthSignatureMethod Class Reference

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

Inheritance diagram for 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

Licence:

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 (   $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 OAuthSignatureMethod\check_signature().

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 OAuthSignatureMethod\build_signature().

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:

• OAuthSignatureMethod.php