ywww: goodreads/OAuth.php annotate

annotate goodreads/OAuth.php @ 8:226f00d9f6f5

another error check

author	Henry Thompson <ht@markup.co.uk>
date	Fri, 17 Feb 2017 15:22:53 +0000
parents	077b0a0a3e6d
children

rev	line source
6 077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	1 <?php
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	2 // vim: foldmethod=marker
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	3
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	4 /* Generic exception class
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	5 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	6 class OAuthException extends Exception {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	7 // pass
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	8 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	9
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	10 class OAuthConsumer {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	11 public $key;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	12 public $secret;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	13
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	14 function __construct($key, $secret, $callback_url=NULL) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	15 $this->key = $key;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	16 $this->secret = $secret;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	17 $this->callback_url = $callback_url;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	18 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	19
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	20 function __toString() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	21 return "OAuthConsumer[key=$this->key,secret=$this->secret]";
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	22 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	23 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	24
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	25 class OAuthToken {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	26 // access tokens and request tokens
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	27 public $key;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	28 public $secret;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	29
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	30 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	31 * key = the token
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	32 * secret = the token secret
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	33 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	34 function __construct($key, $secret) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	35 $this->key = $key;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	36 $this->secret = $secret;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	37 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	38
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	39 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	40 * generates the basic string serialization of a token that a server
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	41 * would respond to request_token and access_token calls with
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	42 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	43 function to_string() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	44 return "oauth_token=" .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	45 OAuthUtil::urlencode_rfc3986($this->key) .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	46 "&oauth_token_secret=" .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	47 OAuthUtil::urlencode_rfc3986($this->secret);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	48 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	49
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	50 function __toString() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	51 return $this->to_string();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	52 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	53 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	54
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	55 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	56 * A class for implementing a Signature Method
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	57 * See section 9 ("Signing Requests") in the spec
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	58 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	59 abstract class OAuthSignatureMethod {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	60 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	61 * Needs to return the name of the Signature Method (ie HMAC-SHA1)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	62 * @return string
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	63 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	64 abstract public function get_name();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	65
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	66 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	67 * Build up the signature
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	68 * NOTE: The output of this function MUST NOT be urlencoded.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	69 * the encoding is handled in OAuthRequest when the final
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	70 * request is serialized
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	71 * @param OAuthRequest $request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	72 * @param OAuthConsumer $consumer
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	73 * @param OAuthToken $token
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	74 * @return string
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	75 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	76 abstract public function build_signature($request, $consumer, $token);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	77
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	78 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	79 * Verifies that a given signature is correct
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	80 * @param OAuthRequest $request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	81 * @param OAuthConsumer $consumer
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	82 * @param OAuthToken $token
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	83 * @param string $signature
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	84 * @return bool
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	85 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	86 public function check_signature($request, $consumer, $token, $signature) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	87 $built = $this->build_signature($request, $consumer, $token);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	88 return $built == $signature;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	89 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	90 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	91
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	92 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	93 * The HMAC-SHA1 signature method uses the HMAC-SHA1 signature algorithm as defined in [RFC2104]
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	94 * where the Signature Base String is the text and the key is the concatenated values (each first
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	95 * encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&'
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	96 * character (ASCII code 38) even if empty.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	97 * - Chapter 9.2 ("HMAC-SHA1")
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	98 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	99 class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	100 function get_name() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	101 return "HMAC-SHA1";
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	102 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	103
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	104 public function build_signature($request, $consumer, $token) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	105 $base_string = $request->get_signature_base_string();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	106 $request->base_string = $base_string;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	107
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	108 $key_parts = array(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	109 $consumer->secret,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	110 ($token) ? $token->secret : ""
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	111 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	112
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	113 $key_parts = OAuthUtil::urlencode_rfc3986($key_parts);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	114 $key = implode('&', $key_parts);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	115
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	116 return base64_encode(hash_hmac('sha1', $base_string, $key, true));
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	117 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	118 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	119
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	120 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	121 * The PLAINTEXT method does not provide any security protection and SHOULD only be used
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	122 * over a secure channel such as HTTPS. It does not use the Signature Base String.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	123 * - Chapter 9.4 ("PLAINTEXT")
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	124 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	125 class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	126 public function get_name() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	127 return "PLAINTEXT";
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	128 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	129
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	130 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	131 * oauth_signature is set to the concatenated encoded values of the Consumer Secret and
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	132 * Token Secret, separated by a '&' character (ASCII code 38), even if either secret is
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	133 * empty. The result MUST be encoded again.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	134 * - Chapter 9.4.1 ("Generating Signatures")
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	135 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	136 * Please note that the second encoding MUST NOT happen in the SignatureMethod, as
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	137 * OAuthRequest handles this!
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	138 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	139 public function build_signature($request, $consumer, $token) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	140 $key_parts = array(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	141 $consumer->secret,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	142 ($token) ? $token->secret : ""
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	143 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	144
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	145 $key_parts = OAuthUtil::urlencode_rfc3986($key_parts);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	146 $key = implode('&', $key_parts);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	147 $request->base_string = $key;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	148
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	149 return $key;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	150 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	151 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	152
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	153 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	154 * The RSA-SHA1 signature method uses the RSASSA-PKCS1-v1_5 signature algorithm as defined in
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	155 * [RFC3447] section 8.2 (more simply known as PKCS#1), using SHA-1 as the hash function for
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	156 * EMSA-PKCS1-v1_5. It is assumed that the Consumer has provided its RSA public key in a
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	157 * verified way to the Service Provider, in a manner which is beyond the scope of this
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	158 * specification.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	159 * - Chapter 9.3 ("RSA-SHA1")
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	160 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	161 abstract class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	162 public function get_name() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	163 return "RSA-SHA1";
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	164 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	165
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	166 // Up to the SP to implement this lookup of keys. Possible ideas are:
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	167 // (1) do a lookup in a table of trusted certs keyed off of consumer
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	168 // (2) fetch via http using a url provided by the requester
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	169 // (3) some sort of specific discovery code based on request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	170 //
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	171 // Either way should return a string representation of the certificate
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	172 protected abstract function fetch_public_cert(&$request);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	173
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	174 // Up to the SP to implement this lookup of keys. Possible ideas are:
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	175 // (1) do a lookup in a table of trusted certs keyed off of consumer
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	176 //
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	177 // Either way should return a string representation of the certificate
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	178 protected abstract function fetch_private_cert(&$request);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	179
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	180 public function build_signature($request, $consumer, $token) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	181 $base_string = $request->get_signature_base_string();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	182 $request->base_string = $base_string;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	183
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	184 // Fetch the private key cert based on the request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	185 $cert = $this->fetch_private_cert($request);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	186
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	187 // Pull the private key ID from the certificate
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	188 $privatekeyid = openssl_get_privatekey($cert);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	189
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	190 // Sign using the key
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	191 $ok = openssl_sign($base_string, $signature, $privatekeyid);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	192
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	193 // Release the key resource
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	194 openssl_free_key($privatekeyid);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	195
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	196 return base64_encode($signature);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	197 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	198
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	199 public function check_signature($request, $consumer, $token, $signature) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	200 $decoded_sig = base64_decode($signature);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	201
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	202 $base_string = $request->get_signature_base_string();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	203
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	204 // Fetch the public key cert based on the request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	205 $cert = $this->fetch_public_cert($request);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	206
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	207 // Pull the public key ID from the certificate
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	208 $publickeyid = openssl_get_publickey($cert);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	209
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	210 // Check the computed signature against the one passed in the query
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	211 $ok = openssl_verify($base_string, $decoded_sig, $publickeyid);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	212
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	213 // Release the key resource
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	214 openssl_free_key($publickeyid);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	215
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	216 return $ok == 1;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	217 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	218 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	219
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	220 class OAuthRequest {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	221 private $parameters;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	222 private $http_method;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	223 private $http_url;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	224 // for debug purposes
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	225 public $base_string;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	226 public static $version = '1.0';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	227 public static $POST_INPUT = 'php://input';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	228
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	229 function __construct($http_method, $http_url, $parameters=NULL) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	230 @$parameters or $parameters = array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	231 $parameters = array_merge( OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	232 $this->parameters = $parameters;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	233 $this->http_method = $http_method;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	234 $this->http_url = $http_url;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	235 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	236
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	237
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	238 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	239 * attempt to build up a request from what was passed to the server
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	240 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	241 public static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	242 $scheme = (!isset($_SERVER['HTTPS']) \|\| $_SERVER['HTTPS'] != "on")
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	243 ? 'http'
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	244 : 'https';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	245 @$http_url or $http_url = $scheme .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	246 '://' . $_SERVER['HTTP_HOST'] .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	247 ':' .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	248 $_SERVER['SERVER_PORT'] .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	249 $_SERVER['REQUEST_URI'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	250 @$http_method or $http_method = $_SERVER['REQUEST_METHOD'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	251
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	252 // We weren't handed any parameters, so let's find the ones relevant to
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	253 // this request.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	254 // If you run XML-RPC or similar you should use this to provide your own
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	255 // parsed parameter-list
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	256 if (!$parameters) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	257 // Find request headers
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	258 $request_headers = OAuthUtil::get_headers();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	259
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	260 // Parse the query-string to find GET parameters
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	261 $parameters = OAuthUtil::parse_parameters($_SERVER['QUERY_STRING']);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	262
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	263 // It's a POST request of the proper content-type, so parse POST
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	264 // parameters and add those overriding any duplicates from GET
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	265 if ($http_method == "POST"
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	266 && @strstr($request_headers["Content-Type"],
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	267 "application/x-www-form-urlencoded")
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	268 ) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	269 $post_data = OAuthUtil::parse_parameters(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	270 file_get_contents(self::$POST_INPUT)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	271 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	272 $parameters = array_merge($parameters, $post_data);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	273 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	274
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	275 // We have a Authorization-header with OAuth data. Parse the header
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	276 // and add those overriding any duplicates from GET or POST
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	277 if (@substr($request_headers['Authorization'], 0, 6) == "OAuth ") {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	278 $header_parameters = OAuthUtil::split_header(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	279 $request_headers['Authorization']
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	280 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	281 $parameters = array_merge($parameters, $header_parameters);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	282 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	283
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	284 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	285
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	286 return new OAuthRequest($http_method, $http_url, $parameters);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	287 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	288
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	289 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	290 * pretty much a helper function to set up the request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	291 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	292 public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	293 @$parameters or $parameters = array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	294 $defaults = array("oauth_version" => OAuthRequest::$version,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	295 "oauth_nonce" => OAuthRequest::generate_nonce(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	296 "oauth_timestamp" => OAuthRequest::generate_timestamp(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	297 "oauth_consumer_key" => $consumer->key);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	298 if ($token)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	299 $defaults['oauth_token'] = $token->key;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	300
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	301 $parameters = array_merge($defaults, $parameters);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	302
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	303 return new OAuthRequest($http_method, $http_url, $parameters);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	304 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	305
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	306 public function set_parameter($name, $value, $allow_duplicates = true) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	307 if ($allow_duplicates && isset($this->parameters[$name])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	308 // We have already added parameter(s) with this name, so add to the list
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	309 if (is_scalar($this->parameters[$name])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	310 // This is the first duplicate, so transform scalar (string)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	311 // into an array so we can add the duplicates
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	312 $this->parameters[$name] = array($this->parameters[$name]);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	313 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	314
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	315 $this->parameters[$name][] = $value;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	316 } else {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	317 $this->parameters[$name] = $value;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	318 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	319 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	320
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	321 public function get_parameter($name) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	322 return isset($this->parameters[$name]) ? $this->parameters[$name] : null;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	323 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	324
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	325 public function get_parameters() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	326 return $this->parameters;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	327 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	328
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	329 public function unset_parameter($name) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	330 unset($this->parameters[$name]);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	331 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	332
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	333 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	334 * The request parameters, sorted and concatenated into a normalized string.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	335 * @return string
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	336 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	337 public function get_signable_parameters() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	338 // Grab all parameters
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	339 $params = $this->parameters;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	340
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	341 // Remove oauth_signature if present
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	342 // Ref: Spec: 9.1.1 ("The oauth_signature parameter MUST be excluded.")
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	343 if (isset($params['oauth_signature'])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	344 unset($params['oauth_signature']);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	345 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	346
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	347 return OAuthUtil::build_http_query($params);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	348 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	349
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	350 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	351 * Returns the base string of this request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	352 *
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	353 * The base string defined as the method, the url
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	354 * and the parameters (normalized), each urlencoded
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	355 * and the concated with &.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	356 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	357 public function get_signature_base_string() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	358 $parts = array(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	359 $this->get_normalized_http_method(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	360 $this->get_normalized_http_url(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	361 $this->get_signable_parameters()
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	362 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	363
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	364 $parts = OAuthUtil::urlencode_rfc3986($parts);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	365
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	366 return implode('&', $parts);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	367 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	368
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	369 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	370 * just uppercases the http method
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	371 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	372 public function get_normalized_http_method() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	373 return strtoupper($this->http_method);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	374 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	375
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	376 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	377 * parses the url and rebuilds it to be
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	378 * scheme://host/path
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	379 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	380 public function get_normalized_http_url() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	381 $parts = parse_url($this->http_url);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	382
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	383 $port = @$parts['port'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	384 $scheme = $parts['scheme'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	385 $host = $parts['host'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	386 $path = @$parts['path'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	387
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	388 $port or $port = ($scheme == 'https') ? '443' : '80';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	389
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	390 if (($scheme == 'https' && $port != '443')
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	391 \|\| ($scheme == 'http' && $port != '80')) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	392 $host = "$host:$port";
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	393 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	394 return "$scheme://$host$path";
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	395 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	396
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	397 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	398 * builds a url usable for a GET request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	399 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	400 public function to_url() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	401 $post_data = $this->to_postdata();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	402 $out = $this->get_normalized_http_url();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	403 if ($post_data) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	404 $out .= '?'.$post_data;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	405 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	406 return $out;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	407 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	408
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	409 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	410 * builds the data one would send in a POST request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	411 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	412 public function to_postdata() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	413 return OAuthUtil::build_http_query($this->parameters);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	414 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	415
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	416 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	417 * builds the Authorization: header
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	418 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	419 public function to_header($realm=null) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	420 $first = true;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	421 if($realm) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	422 $out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	423 $first = false;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	424 } else
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	425 $out = 'Authorization: OAuth';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	426
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	427 $total = array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	428 foreach ($this->parameters as $k => $v) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	429 if (substr($k, 0, 5) != "oauth") continue;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	430 if (is_array($v)) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	431 throw new OAuthException('Arrays not supported in headers');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	432 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	433 $out .= ($first) ? ' ' : ',';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	434 $out .= OAuthUtil::urlencode_rfc3986($k) .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	435 '="' .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	436 OAuthUtil::urlencode_rfc3986($v) .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	437 '"';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	438 $first = false;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	439 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	440 return $out;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	441 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	442
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	443 public function __toString() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	444 return $this->to_url();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	445 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	446
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	447
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	448 public function sign_request($signature_method, $consumer, $token) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	449 $this->set_parameter(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	450 "oauth_signature_method",
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	451 $signature_method->get_name(),
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	452 false
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	453 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	454 $signature = $this->build_signature($signature_method, $consumer, $token);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	455 $this->set_parameter("oauth_signature", $signature, false);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	456 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	457
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	458 public function build_signature($signature_method, $consumer, $token) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	459 $signature = $signature_method->build_signature($this, $consumer, $token);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	460 return $signature;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	461 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	462
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	463 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	464 * util function: current timestamp
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	465 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	466 private static function generate_timestamp() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	467 return time();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	468 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	469
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	470 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	471 * util function: current nonce
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	472 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	473 private static function generate_nonce() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	474 $mt = microtime();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	475 $rand = mt_rand();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	476
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	477 return md5($mt . $rand); // md5s look nicer than numbers
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	478 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	479 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	480
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	481 class OAuthServer {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	482 protected $timestamp_threshold = 300; // in seconds, five minutes
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	483 protected $version = '1.0'; // hi blaine
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	484 protected $signature_methods = array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	485
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	486 protected $data_store;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	487
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	488 function __construct($data_store) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	489 $this->data_store = $data_store;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	490 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	491
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	492 public function add_signature_method($signature_method) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	493 $this->signature_methods[$signature_method->get_name()] =
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	494 $signature_method;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	495 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	496
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	497 // high level functions
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	498
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	499 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	500 * process a request_token request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	501 * returns the request token on success
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	502 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	503 public function fetch_request_token(&$request) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	504 $this->get_version($request);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	505
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	506 $consumer = $this->get_consumer($request);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	507
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	508 // no token required for the initial token request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	509 $token = NULL;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	510
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	511 $this->check_signature($request, $consumer, $token);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	512
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	513 // Rev A change
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	514 $callback = $request->get_parameter('oauth_callback');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	515 $new_token = $this->data_store->new_request_token($consumer, $callback);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	516
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	517 return $new_token;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	518 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	519
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	520 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	521 * process an access_token request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	522 * returns the access token on success
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	523 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	524 public function fetch_access_token(&$request) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	525 $this->get_version($request);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	526
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	527 $consumer = $this->get_consumer($request);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	528
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	529 // requires authorized request token
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	530 $token = $this->get_token($request, $consumer, "request");
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	531
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	532 $this->check_signature($request, $consumer, $token);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	533
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	534 // Rev A change
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	535 $verifier = $request->get_parameter('oauth_verifier');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	536 $new_token = $this->data_store->new_access_token($token, $consumer, $verifier);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	537
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	538 return $new_token;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	539 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	540
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	541 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	542 * verify an api call, checks all the parameters
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	543 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	544 public function verify_request(&$request) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	545 $this->get_version($request);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	546 $consumer = $this->get_consumer($request);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	547 $token = $this->get_token($request, $consumer, "access");
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	548 $this->check_signature($request, $consumer, $token);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	549 return array($consumer, $token);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	550 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	551
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	552 // Internals from here
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	553 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	554 * version 1
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	555 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	556 private function get_version(&$request) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	557 $version = $request->get_parameter("oauth_version");
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	558 if (!$version) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	559 // Service Providers MUST assume the protocol version to be 1.0 if this parameter is not present.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	560 // Chapter 7.0 ("Accessing Protected Ressources")
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	561 $version = '1.0';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	562 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	563 if ($version !== $this->version) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	564 throw new OAuthException("OAuth version '$version' not supported");
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	565 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	566 return $version;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	567 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	568
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	569 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	570 * figure out the signature with some defaults
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	571 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	572 private function get_signature_method(&$request) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	573 $signature_method =
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	574 @$request->get_parameter("oauth_signature_method");
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	575
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	576 if (!$signature_method) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	577 // According to chapter 7 ("Accessing Protected Ressources") the signature-method
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	578 // parameter is required, and we can't just fallback to PLAINTEXT
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	579 throw new OAuthException('No signature method parameter. This parameter is required');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	580 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	581
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	582 if (!in_array($signature_method,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	583 array_keys($this->signature_methods))) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	584 throw new OAuthException(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	585 "Signature method '$signature_method' not supported " .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	586 "try one of the following: " .
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	587 implode(", ", array_keys($this->signature_methods))
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	588 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	589 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	590 return $this->signature_methods[$signature_method];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	591 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	592
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	593 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	594 * try to find the consumer for the provided request's consumer key
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	595 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	596 private function get_consumer(&$request) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	597 $consumer_key = @$request->get_parameter("oauth_consumer_key");
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	598 if (!$consumer_key) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	599 throw new OAuthException("Invalid consumer key");
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	600 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	601
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	602 $consumer = $this->data_store->lookup_consumer($consumer_key);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	603 if (!$consumer) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	604 throw new OAuthException("Invalid consumer");
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	605 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	606
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	607 return $consumer;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	608 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	609
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	610 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	611 * try to find the token for the provided request's token key
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	612 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	613 private function get_token(&$request, $consumer, $token_type="access") {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	614 $token_field = @$request->get_parameter('oauth_token');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	615 $token = $this->data_store->lookup_token(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	616 $consumer, $token_type, $token_field
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	617 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	618 if (!$token) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	619 throw new OAuthException("Invalid $token_type token: $token_field");
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	620 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	621 return $token;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	622 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	623
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	624 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	625 * all-in-one function to check the signature on a request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	626 * should guess the signature method appropriately
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	627 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	628 private function check_signature(&$request, $consumer, $token) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	629 // this should probably be in a different method
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	630 $timestamp = @$request->get_parameter('oauth_timestamp');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	631 $nonce = @$request->get_parameter('oauth_nonce');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	632
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	633 $this->check_timestamp($timestamp);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	634 $this->check_nonce($consumer, $token, $nonce, $timestamp);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	635
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	636 $signature_method = $this->get_signature_method($request);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	637
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	638 $signature = $request->get_parameter('oauth_signature');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	639 $valid_sig = $signature_method->check_signature(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	640 $request,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	641 $consumer,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	642 $token,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	643 $signature
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	644 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	645
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	646 if (!$valid_sig) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	647 throw new OAuthException("Invalid signature");
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	648 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	649 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	650
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	651 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	652 * check that the timestamp is new enough
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	653 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	654 private function check_timestamp($timestamp) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	655 if( ! $timestamp )
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	656 throw new OAuthException(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	657 'Missing timestamp parameter. The parameter is required'
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	658 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	659
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	660 // verify that timestamp is recentish
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	661 $now = time();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	662 if (abs($now - $timestamp) > $this->timestamp_threshold) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	663 throw new OAuthException(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	664 "Expired timestamp, yours $timestamp, ours $now"
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	665 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	666 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	667 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	668
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	669 /**
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	670 * check that the nonce is not repeated
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	671 */
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	672 private function check_nonce($consumer, $token, $nonce, $timestamp) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	673 if( ! $nonce )
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	674 throw new OAuthException(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	675 'Missing nonce parameter. The parameter is required'
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	676 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	677
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	678 // verify that the nonce is uniqueish
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	679 $found = $this->data_store->lookup_nonce(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	680 $consumer,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	681 $token,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	682 $nonce,
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	683 $timestamp
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	684 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	685 if ($found) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	686 throw new OAuthException("Nonce already used: $nonce");
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	687 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	688 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	689
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	690 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	691
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	692 class OAuthDataStore {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	693 function lookup_consumer($consumer_key) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	694 // implement me
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	695 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	696
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	697 function lookup_token($consumer, $token_type, $token) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	698 // implement me
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	699 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	700
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	701 function lookup_nonce($consumer, $token, $nonce, $timestamp) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	702 // implement me
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	703 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	704
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	705 function new_request_token($consumer, $callback = null) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	706 // return a new token attached to this consumer
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	707 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	708
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	709 function new_access_token($token, $consumer, $verifier = null) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	710 // return a new access token attached to this consumer
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	711 // for the user associated with this token if the request token
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	712 // is authorized
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	713 // should also invalidate the request token
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	714 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	715
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	716 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	717
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	718 class OAuthUtil {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	719 public static function urlencode_rfc3986($input) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	720 if (is_array($input)) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	721 return array_map(array('OAuthUtil', 'urlencode_rfc3986'), $input);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	722 } else if (is_scalar($input)) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	723 return str_replace(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	724 '+',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	725 ' ',
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	726 str_replace('%7E', '~', rawurlencode($input))
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	727 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	728 } else {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	729 return '';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	730 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	731 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	732
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	733
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	734 // This decode function isn't taking into consideration the above
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	735 // modifications to the encoding process. However, this method doesn't
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	736 // seem to be used anywhere so leaving it as is.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	737 public static function urldecode_rfc3986($string) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	738 return urldecode($string);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	739 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	740
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	741 // Utility function for turning the Authorization: header into
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	742 // parameters, has to do some unescaping
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	743 // Can filter out any non-oauth parameters if needed (default behaviour)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	744 // May 28th, 2010 - method updated to tjerk.meesters for a speed improvement.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	745 // see http://code.google.com/p/oauth/issues/detail?id=163
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	746 public static function split_header($header, $only_allow_oauth_parameters = true) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	747 $params = array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	748 if (preg_match_all('/('.($only_allow_oauth_parameters ? 'oauth_' : '').'[a-z_-])=(:?"([^"])"\|([^,]*))/', $header, $matches)) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	749 foreach ($matches[1] as $i => $h) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	750 $params[$h] = OAuthUtil::urldecode_rfc3986(empty($matches[3][$i]) ? $matches[4][$i] : $matches[3][$i]);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	751 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	752 if (isset($params['realm'])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	753 unset($params['realm']);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	754 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	755 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	756 return $params;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	757 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	758
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	759 // helper to try to sort out headers for people who aren't running apache
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	760 public static function get_headers() {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	761 if (function_exists('apache_request_headers')) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	762 // we need this to get the actual Authorization: header
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	763 // because apache tends to tell us it doesn't exist
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	764 $headers = apache_request_headers();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	765
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	766 // sanitize the output of apache_request_headers because
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	767 // we always want the keys to be Cased-Like-This and arh()
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	768 // returns the headers in the same case as they are in the
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	769 // request
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	770 $out = array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	771 foreach ($headers AS $key => $value) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	772 $key = str_replace(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	773 " ",
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	774 "-",
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	775 ucwords(strtolower(str_replace("-", " ", $key)))
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	776 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	777 $out[$key] = $value;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	778 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	779 } else {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	780 // otherwise we don't have apache and are just going to have to hope
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	781 // that $_SERVER actually contains what we need
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	782 $out = array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	783 if( isset($_SERVER['CONTENT_TYPE']) )
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	784 $out['Content-Type'] = $_SERVER['CONTENT_TYPE'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	785 if( isset($_ENV['CONTENT_TYPE']) )
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	786 $out['Content-Type'] = $_ENV['CONTENT_TYPE'];
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	787
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	788 foreach ($_SERVER as $key => $value) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	789 if (substr($key, 0, 5) == "HTTP_") {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	790 // this is chaos, basically it is just there to capitalize the first
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	791 // letter of every word that is not an initial HTTP and strip HTTP
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	792 // code from przemek
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	793 $key = str_replace(
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	794 " ",
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	795 "-",
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	796 ucwords(strtolower(str_replace("_", " ", substr($key, 5))))
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	797 );
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	798 $out[$key] = $value;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	799 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	800 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	801 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	802 return $out;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	803 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	804
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	805 // This function takes a input like a=b&a=c&d=e and returns the parsed
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	806 // parameters like this
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	807 // array('a' => array('b','c'), 'd' => 'e')
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	808 public static function parse_parameters( $input ) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	809 if (!isset($input) \|\| !$input) return array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	810
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	811 $pairs = explode('&', $input);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	812
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	813 $parsed_parameters = array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	814 foreach ($pairs as $pair) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	815 $split = explode('=', $pair, 2);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	816 $parameter = OAuthUtil::urldecode_rfc3986($split[0]);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	817 $value = isset($split[1]) ? OAuthUtil::urldecode_rfc3986($split[1]) : '';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	818
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	819 if (isset($parsed_parameters[$parameter])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	820 // We have already recieved parameter(s) with this name, so add to the list
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	821 // of parameters with this name
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	822
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	823 if (is_scalar($parsed_parameters[$parameter])) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	824 // This is the first duplicate, so transform scalar (string) into an array
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	825 // so we can add the duplicates
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	826 $parsed_parameters[$parameter] = array($parsed_parameters[$parameter]);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	827 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	828
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	829 $parsed_parameters[$parameter][] = $value;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	830 } else {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	831 $parsed_parameters[$parameter] = $value;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	832 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	833 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	834 return $parsed_parameters;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	835 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	836
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	837 public static function build_http_query($params) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	838 if (!$params) return '';
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	839
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	840 // Urlencode both keys and values
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	841 $keys = OAuthUtil::urlencode_rfc3986(array_keys($params));
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	842 $values = OAuthUtil::urlencode_rfc3986(array_values($params));
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	843 $params = array_combine($keys, $values);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	844
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	845 // Parameters are sorted by name, using lexicographical byte value ordering.
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	846 // Ref: Spec: 9.1.1 (1)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	847 uksort($params, 'strcmp');
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	848
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	849 $pairs = array();
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	850 foreach ($params as $parameter => $value) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	851 if (is_array($value)) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	852 // If two or more parameters share the same name, they are sorted by their value
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	853 // Ref: Spec: 9.1.1 (1)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	854 natsort($value);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	855 foreach ($value as $duplicate_value) {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	856 $pairs[] = $parameter . '=' . $duplicate_value;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	857 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	858 } else {
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	859 $pairs[] = $parameter . '=' . $value;
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	860 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	861 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	862 // For each parameter, the name is separated from the corresponding value by an '=' character (ASCII code 61)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	863 // Each name-value pair is separated by an '&' character (ASCII code 38)
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	864 return implode('&', $pairs);
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	865 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	866 }
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	867
077b0a0a3e6d remaining originals according to dependency walk Robert Boland <robert@markup.co.uk> parents: diff changeset	868 ?>

Mercurial > hg > ywww

annotate goodreads/OAuth.php @ 8:226f00d9f6f5