]> git.mxchange.org Git - friendica-addons.git/blobdiff - tumblr/tumblroauth/OAuth.php
Revert "Move TwitterOAuth to Composer, part 2 : StatusNet and Tumblr"
[friendica-addons.git] / tumblr / tumblroauth / OAuth.php
diff --git a/tumblr/tumblroauth/OAuth.php b/tumblr/tumblroauth/OAuth.php
new file mode 100644 (file)
index 0000000..982aaa5
--- /dev/null
@@ -0,0 +1,874 @@
+<?php\r
+// vim: foldmethod=marker\r
+\r
+/* Generic exception class\r
+ */\r
+class OAuthException extends Exception {\r
+  // pass\r
+}\r
+\r
+class OAuthConsumer {\r
+  public $key;\r
+  public $secret;\r
+\r
+  function __construct($key, $secret, $callback_url=NULL) {\r
+    $this->key = $key;\r
+    $this->secret = $secret;\r
+    $this->callback_url = $callback_url;\r
+  }\r
+\r
+  function __toString() {\r
+    return "OAuthConsumer[key=$this->key,secret=$this->secret]";\r
+  }\r
+}\r
+\r
+class OAuthToken {\r
+  // access tokens and request tokens\r
+  public $key;\r
+  public $secret;\r
+\r
+  /**\r
+   * key = the token\r
+   * secret = the token secret\r
+   */\r
+  function __construct($key, $secret) {\r
+    $this->key = $key;\r
+    $this->secret = $secret;\r
+  }\r
+\r
+  /**\r
+   * generates the basic string serialization of a token that a server\r
+   * would respond to request_token and access_token calls with\r
+   */\r
+  function to_string() {\r
+    return "oauth_token=" .\r
+           OAuthUtil::urlencode_rfc3986($this->key) .\r
+           "&oauth_token_secret=" .\r
+           OAuthUtil::urlencode_rfc3986($this->secret);\r
+  }\r
+\r
+  function __toString() {\r
+    return $this->to_string();\r
+  }\r
+}\r
+\r
+/**\r
+ * A class for implementing a Signature Method\r
+ * See section 9 ("Signing Requests") in the spec\r
+ */\r
+abstract class OAuthSignatureMethod {\r
+  /**\r
+   * Needs to return the name of the Signature Method (ie HMAC-SHA1)\r
+   * @return string\r
+   */\r
+  abstract public function get_name();\r
+\r
+  /**\r
+   * Build up the signature\r
+   * NOTE: The output of this function MUST NOT be urlencoded.\r
+   * the encoding is handled in OAuthRequest when the final\r
+   * request is serialized\r
+   * @param OAuthRequest $request\r
+   * @param OAuthConsumer $consumer\r
+   * @param OAuthToken $token\r
+   * @return string\r
+   */\r
+  abstract public function build_signature($request, $consumer, $token);\r
+\r
+  /**\r
+   * Verifies that a given signature is correct\r
+   * @param OAuthRequest $request\r
+   * @param OAuthConsumer $consumer\r
+   * @param OAuthToken $token\r
+   * @param string $signature\r
+   * @return bool\r
+   */\r
+  public function check_signature($request, $consumer, $token, $signature) {\r
+    $built = $this->build_signature($request, $consumer, $token);\r
+    return $built == $signature;\r
+  }\r
+}\r
+\r
+/**\r
+ * The HMAC-SHA1 signature method uses the HMAC-SHA1 signature algorithm as defined in [RFC2104] \r
+ * where the Signature Base String is the text and the key is the concatenated values (each first \r
+ * encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&' \r
+ * character (ASCII code 38) even if empty.\r
+ *   - Chapter 9.2 ("HMAC-SHA1")\r
+ */\r
+class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod {\r
+  function get_name() {\r
+    return "HMAC-SHA1";\r
+  }\r
+\r
+  public function build_signature($request, $consumer, $token) {\r
+    $base_string = $request->get_signature_base_string();\r
+    $request->base_string = $base_string;\r
+\r
+    $key_parts = array(\r
+      $consumer->secret,\r
+      ($token) ? $token->secret : ""\r
+    );\r
+\r
+    $key_parts = OAuthUtil::urlencode_rfc3986($key_parts);\r
+    $key = implode('&', $key_parts);\r
+\r
+    return base64_encode(hash_hmac('sha1', $base_string, $key, true));\r
+  }\r
+}\r
+\r
+/**\r
+ * The PLAINTEXT method does not provide any security protection and SHOULD only be used \r
+ * over a secure channel such as HTTPS. It does not use the Signature Base String.\r
+ *   - Chapter 9.4 ("PLAINTEXT")\r
+ */\r
+class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod {\r
+  public function get_name() {\r
+    return "PLAINTEXT";\r
+  }\r
+\r
+  /**\r
+   * oauth_signature is set to the concatenated encoded values of the Consumer Secret and \r
+   * Token Secret, separated by a '&' character (ASCII code 38), even if either secret is \r
+   * empty. The result MUST be encoded again.\r
+   *   - Chapter 9.4.1 ("Generating Signatures")\r
+   *\r
+   * Please note that the second encoding MUST NOT happen in the SignatureMethod, as\r
+   * OAuthRequest handles this!\r
+   */\r
+  public function build_signature($request, $consumer, $token) {\r
+    $key_parts = array(\r
+      $consumer->secret,\r
+      ($token) ? $token->secret : ""\r
+    );\r
+\r
+    $key_parts = OAuthUtil::urlencode_rfc3986($key_parts);\r
+    $key = implode('&', $key_parts);\r
+    $request->base_string = $key;\r
+\r
+    return $key;\r
+  }\r
+}\r
+\r
+/**\r
+ * The RSA-SHA1 signature method uses the RSASSA-PKCS1-v1_5 signature algorithm as defined in \r
+ * [RFC3447] section 8.2 (more simply known as PKCS#1), using SHA-1 as the hash function for \r
+ * EMSA-PKCS1-v1_5. It is assumed that the Consumer has provided its RSA public key in a \r
+ * verified way to the Service Provider, in a manner which is beyond the scope of this \r
+ * specification.\r
+ *   - Chapter 9.3 ("RSA-SHA1")\r
+ */\r
+abstract class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod {\r
+  public function get_name() {\r
+    return "RSA-SHA1";\r
+  }\r
+\r
+  // Up to the SP to implement this lookup of keys. Possible ideas are:\r
+  // (1) do a lookup in a table of trusted certs keyed off of consumer\r
+  // (2) fetch via http using a url provided by the requester\r
+  // (3) some sort of specific discovery code based on request\r
+  //\r
+  // Either way should return a string representation of the certificate\r
+  protected abstract function fetch_public_cert(&$request);\r
+\r
+  // Up to the SP to implement this lookup of keys. Possible ideas are:\r
+  // (1) do a lookup in a table of trusted certs keyed off of consumer\r
+  //\r
+  // Either way should return a string representation of the certificate\r
+  protected abstract function fetch_private_cert(&$request);\r
+\r
+  public function build_signature($request, $consumer, $token) {\r
+    $base_string = $request->get_signature_base_string();\r
+    $request->base_string = $base_string;\r
+\r
+    // Fetch the private key cert based on the request\r
+    $cert = $this->fetch_private_cert($request);\r
+\r
+    // Pull the private key ID from the certificate\r
+    $privatekeyid = openssl_get_privatekey($cert);\r
+\r
+    // Sign using the key\r
+    $ok = openssl_sign($base_string, $signature, $privatekeyid);\r
+\r
+    // Release the key resource\r
+    openssl_free_key($privatekeyid);\r
+\r
+    return base64_encode($signature);\r
+  }\r
+\r
+  public function check_signature($request, $consumer, $token, $signature) {\r
+    $decoded_sig = base64_decode($signature);\r
+\r
+    $base_string = $request->get_signature_base_string();\r
+\r
+    // Fetch the public key cert based on the request\r
+    $cert = $this->fetch_public_cert($request);\r
+\r
+    // Pull the public key ID from the certificate\r
+    $publickeyid = openssl_get_publickey($cert);\r
+\r
+    // Check the computed signature against the one passed in the query\r
+    $ok = openssl_verify($base_string, $decoded_sig, $publickeyid);\r
+\r
+    // Release the key resource\r
+    openssl_free_key($publickeyid);\r
+\r
+    return $ok == 1;\r
+  }\r
+}\r
+\r
+class OAuthRequest {\r
+  private $parameters;\r
+  private $http_method;\r
+  private $http_url;\r
+  // for debug purposes\r
+  public $base_string;\r
+  public static $version = '1.0';\r
+  public static $POST_INPUT = 'php://input';\r
+\r
+  function __construct($http_method, $http_url, $parameters=NULL) {\r
+    @$parameters or $parameters = array();\r
+    $parameters = array_merge( OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters);\r
+    $this->parameters = $parameters;\r
+    $this->http_method = $http_method;\r
+    $this->http_url = $http_url;\r
+  }\r
+\r
+\r
+  /**\r
+   * attempt to build up a request from what was passed to the server\r
+   */\r
+  public static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) {\r
+    $scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on")\r
+              ? 'http'\r
+              : 'https';\r
+    @$http_url or $http_url = $scheme .\r
+                              '://' . $_SERVER['HTTP_HOST'] .\r
+                              ':' .\r
+                              $_SERVER['SERVER_PORT'] .\r
+                              $_SERVER['REQUEST_URI'];\r
+    @$http_method or $http_method = $_SERVER['REQUEST_METHOD'];\r
+\r
+    // We weren't handed any parameters, so let's find the ones relevant to\r
+    // this request.\r
+    // If you run XML-RPC or similar you should use this to provide your own\r
+    // parsed parameter-list\r
+    if (!$parameters) {\r
+      // Find request headers\r
+      $request_headers = OAuthUtil::get_headers();\r
+\r
+      // Parse the query-string to find GET parameters\r
+      $parameters = OAuthUtil::parse_parameters($_SERVER['QUERY_STRING']);\r
+\r
+      // It's a POST request of the proper content-type, so parse POST\r
+      // parameters and add those overriding any duplicates from GET\r
+      if ($http_method == "POST"\r
+          && @strstr($request_headers["Content-Type"],\r
+                     "application/x-www-form-urlencoded")\r
+          ) {\r
+        $post_data = OAuthUtil::parse_parameters(\r
+          file_get_contents(self::$POST_INPUT)\r
+        );\r
+        $parameters = array_merge($parameters, $post_data);\r
+      }\r
+\r
+      // We have a Authorization-header with OAuth data. Parse the header\r
+      // and add those overriding any duplicates from GET or POST\r
+      if (@substr($request_headers['Authorization'], 0, 6) == "OAuth ") {\r
+        $header_parameters = OAuthUtil::split_header(\r
+          $request_headers['Authorization']\r
+        );\r
+        $parameters = array_merge($parameters, $header_parameters);\r
+      }\r
+\r
+    }\r
+\r
+    return new OAuthRequest($http_method, $http_url, $parameters);\r
+  }\r
+\r
+  /**\r
+   * pretty much a helper function to set up the request\r
+   */\r
+  public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL) {\r
+    @$parameters or $parameters = array();\r
+    $defaults = array("oauth_version" => OAuthRequest::$version,\r
+                      "oauth_nonce" => OAuthRequest::generate_nonce(),\r
+                      "oauth_timestamp" => OAuthRequest::generate_timestamp(),\r
+                      "oauth_consumer_key" => $consumer->key);\r
+    if ($token)\r
+      $defaults['oauth_token'] = $token->key;\r
+\r
+    $parameters = array_merge($defaults, $parameters);\r
+\r
+    return new OAuthRequest($http_method, $http_url, $parameters);\r
+  }\r
+\r
+  public function set_parameter($name, $value, $allow_duplicates = true) {\r
+    if ($allow_duplicates && isset($this->parameters[$name])) {\r
+      // We have already added parameter(s) with this name, so add to the list\r
+      if (is_scalar($this->parameters[$name])) {\r
+        // This is the first duplicate, so transform scalar (string)\r
+        // into an array so we can add the duplicates\r
+        $this->parameters[$name] = array($this->parameters[$name]);\r
+      }\r
+\r
+      $this->parameters[$name][] = $value;\r
+    } else {\r
+      $this->parameters[$name] = $value;\r
+    }\r
+  }\r
+\r
+  public function get_parameter($name) {\r
+    return isset($this->parameters[$name]) ? $this->parameters[$name] : null;\r
+  }\r
+\r
+  public function get_parameters() {\r
+    return $this->parameters;\r
+  }\r
+\r
+  public function unset_parameter($name) {\r
+    unset($this->parameters[$name]);\r
+  }\r
+\r
+  /**\r
+   * The request parameters, sorted and concatenated into a normalized string.\r
+   * @return string\r
+   */\r
+  public function get_signable_parameters() {\r
+    // Grab all parameters\r
+    $params = $this->parameters;\r
+\r
+    // Remove oauth_signature if present\r
+    // Ref: Spec: 9.1.1 ("The oauth_signature parameter MUST be excluded.")\r
+    if (isset($params['oauth_signature'])) {\r
+      unset($params['oauth_signature']);\r
+    }\r
+\r
+    return OAuthUtil::build_http_query($params);\r
+  }\r
+\r
+  /**\r
+   * Returns the base string of this request\r
+   *\r
+   * The base string defined as the method, the url\r
+   * and the parameters (normalized), each urlencoded\r
+   * and the concated with &.\r
+   */\r
+  public function get_signature_base_string() {\r
+    $parts = array(\r
+      $this->get_normalized_http_method(),\r
+      $this->get_normalized_http_url(),\r
+      $this->get_signable_parameters()\r
+    );\r
+\r
+    $parts = OAuthUtil::urlencode_rfc3986($parts);\r
+\r
+    return implode('&', $parts);\r
+  }\r
+\r
+  /**\r
+   * just uppercases the http method\r
+   */\r
+  public function get_normalized_http_method() {\r
+    return strtoupper($this->http_method);\r
+  }\r
+\r
+  /**\r
+   * parses the url and rebuilds it to be\r
+   * scheme://host/path\r
+   */\r
+  public function get_normalized_http_url() {\r
+    $parts = parse_url($this->http_url);\r
+\r
+    $port = @$parts['port'];\r
+    $scheme = $parts['scheme'];\r
+    $host = $parts['host'];\r
+    $path = @$parts['path'];\r
+\r
+    $port or $port = ($scheme == 'https') ? '443' : '80';\r
+\r
+    if (($scheme == 'https' && $port != '443')\r
+        || ($scheme == 'http' && $port != '80')) {\r
+      $host = "$host:$port";\r
+    }\r
+    return "$scheme://$host$path";\r
+  }\r
+\r
+  /**\r
+   * builds a url usable for a GET request\r
+   */\r
+  public function to_url() {\r
+    $post_data = $this->to_postdata();\r
+    $out = $this->get_normalized_http_url();\r
+    if ($post_data) {\r
+      $out .= '?'.$post_data;\r
+    }\r
+    return $out;\r
+  }\r
+\r
+  /**\r
+   * builds the data one would send in a POST request\r
+   */\r
+  public function to_postdata() {\r
+    return OAuthUtil::build_http_query($this->parameters);\r
+  }\r
+\r
+  /**\r
+   * builds the Authorization: header\r
+   */\r
+  public function to_header($realm=null) {\r
+    $first = true;\r
+       if($realm) {\r
+      $out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"';\r
+      $first = false;\r
+    } else\r
+      $out = 'Authorization: OAuth';\r
+\r
+    $total = array();\r
+    foreach ($this->parameters as $k => $v) {\r
+      if (substr($k, 0, 5) != "oauth") continue;\r
+      if (is_array($v)) {\r
+        throw new OAuthException('Arrays not supported in headers');\r
+      }\r
+      $out .= ($first) ? ' ' : ',';\r
+      $out .= OAuthUtil::urlencode_rfc3986($k) .\r
+              '="' .\r
+              OAuthUtil::urlencode_rfc3986($v) .\r
+              '"';\r
+      $first = false;\r
+    }\r
+    return $out;\r
+  }\r
+\r
+  public function __toString() {\r
+    return $this->to_url();\r
+  }\r
+\r
+\r
+  public function sign_request($signature_method, $consumer, $token) {\r
+    $this->set_parameter(\r
+      "oauth_signature_method",\r
+      $signature_method->get_name(),\r
+      false\r
+    );\r
+    $signature = $this->build_signature($signature_method, $consumer, $token);\r
+    $this->set_parameter("oauth_signature", $signature, false);\r
+  }\r
+\r
+  public function build_signature($signature_method, $consumer, $token) {\r
+    $signature = $signature_method->build_signature($this, $consumer, $token);\r
+    return $signature;\r
+  }\r
+\r
+  /**\r
+   * util function: current timestamp\r
+   */\r
+  private static function generate_timestamp() {\r
+    return time();\r
+  }\r
+\r
+  /**\r
+   * util function: current nonce\r
+   */\r
+  private static function generate_nonce() {\r
+    $mt = microtime();\r
+    $rand = mt_rand();\r
+\r
+    return md5($mt . $rand); // md5s look nicer than numbers\r
+  }\r
+}\r
+\r
+class OAuthServer {\r
+  protected $timestamp_threshold = 300; // in seconds, five minutes\r
+  protected $version = '1.0';             // hi blaine\r
+  protected $signature_methods = array();\r
+\r
+  protected $data_store;\r
+\r
+  function __construct($data_store) {\r
+    $this->data_store = $data_store;\r
+  }\r
+\r
+  public function add_signature_method($signature_method) {\r
+    $this->signature_methods[$signature_method->get_name()] =\r
+      $signature_method;\r
+  }\r
+\r
+  // high level functions\r
+\r
+  /**\r
+   * process a request_token request\r
+   * returns the request token on success\r
+   */\r
+  public function fetch_request_token(&$request) {\r
+    $this->get_version($request);\r
+\r
+    $consumer = $this->get_consumer($request);\r
+\r
+    // no token required for the initial token request\r
+    $token = NULL;\r
+\r
+    $this->check_signature($request, $consumer, $token);\r
+\r
+    // Rev A change\r
+    $callback = $request->get_parameter('oauth_callback');\r
+    $new_token = $this->data_store->new_request_token($consumer, $callback);\r
+\r
+    return $new_token;\r
+  }\r
+\r
+  /**\r
+   * process an access_token request\r
+   * returns the access token on success\r
+   */\r
+  public function fetch_access_token(&$request) {\r
+    $this->get_version($request);\r
+\r
+    $consumer = $this->get_consumer($request);\r
+\r
+    // requires authorized request token\r
+    $token = $this->get_token($request, $consumer, "request");\r
+\r
+    $this->check_signature($request, $consumer, $token);\r
+\r
+    // Rev A change\r
+    $verifier = $request->get_parameter('oauth_verifier');\r
+    $new_token = $this->data_store->new_access_token($token, $consumer, $verifier);\r
+\r
+    return $new_token;\r
+  }\r
+\r
+  /**\r
+   * verify an api call, checks all the parameters\r
+   */\r
+  public function verify_request(&$request) {\r
+    $this->get_version($request);\r
+    $consumer = $this->get_consumer($request);\r
+    $token = $this->get_token($request, $consumer, "access");\r
+    $this->check_signature($request, $consumer, $token);\r
+    return array($consumer, $token);\r
+  }\r
+\r
+  // Internals from here\r
+  /**\r
+   * version 1\r
+   */\r
+  private function get_version(&$request) {\r
+    $version = $request->get_parameter("oauth_version");\r
+    if (!$version) {\r
+      // Service Providers MUST assume the protocol version to be 1.0 if this parameter is not present. \r
+      // Chapter 7.0 ("Accessing Protected Ressources")\r
+      $version = '1.0';\r
+    }\r
+    if ($version !== $this->version) {\r
+      throw new OAuthException("OAuth version '$version' not supported");\r
+    }\r
+    return $version;\r
+  }\r
+\r
+  /**\r
+   * figure out the signature with some defaults\r
+   */\r
+  private function get_signature_method(&$request) {\r
+    $signature_method =\r
+        @$request->get_parameter("oauth_signature_method");\r
+\r
+    if (!$signature_method) {\r
+      // According to chapter 7 ("Accessing Protected Ressources") the signature-method\r
+      // parameter is required, and we can't just fallback to PLAINTEXT\r
+      throw new OAuthException('No signature method parameter. This parameter is required');\r
+    }\r
+\r
+    if (!in_array($signature_method,\r
+                  array_keys($this->signature_methods))) {\r
+      throw new OAuthException(\r
+        "Signature method '$signature_method' not supported " .\r
+        "try one of the following: " .\r
+        implode(", ", array_keys($this->signature_methods))\r
+      );\r
+    }\r
+    return $this->signature_methods[$signature_method];\r
+  }\r
+\r
+  /**\r
+   * try to find the consumer for the provided request's consumer key\r
+   */\r
+  private function get_consumer(&$request) {\r
+    $consumer_key = @$request->get_parameter("oauth_consumer_key");\r
+    if (!$consumer_key) {\r
+      throw new OAuthException("Invalid consumer key");\r
+    }\r
+\r
+    $consumer = $this->data_store->lookup_consumer($consumer_key);\r
+    if (!$consumer) {\r
+      throw new OAuthException("Invalid consumer");\r
+    }\r
+\r
+    return $consumer;\r
+  }\r
+\r
+  /**\r
+   * try to find the token for the provided request's token key\r
+   */\r
+  private function get_token(&$request, $consumer, $token_type="access") {\r
+    $token_field = @$request->get_parameter('oauth_token');\r
+    $token = $this->data_store->lookup_token(\r
+      $consumer, $token_type, $token_field\r
+    );\r
+    if (!$token) {\r
+      throw new OAuthException("Invalid $token_type token: $token_field");\r
+    }\r
+    return $token;\r
+  }\r
+\r
+  /**\r
+   * all-in-one function to check the signature on a request\r
+   * should guess the signature method appropriately\r
+   */\r
+  private function check_signature(&$request, $consumer, $token) {\r
+    // this should probably be in a different method\r
+    $timestamp = @$request->get_parameter('oauth_timestamp');\r
+    $nonce = @$request->get_parameter('oauth_nonce');\r
+\r
+    $this->check_timestamp($timestamp);\r
+    $this->check_nonce($consumer, $token, $nonce, $timestamp);\r
+\r
+    $signature_method = $this->get_signature_method($request);\r
+\r
+    $signature = $request->get_parameter('oauth_signature');\r
+    $valid_sig = $signature_method->check_signature(\r
+      $request,\r
+      $consumer,\r
+      $token,\r
+      $signature\r
+    );\r
+\r
+    if (!$valid_sig) {\r
+      throw new OAuthException("Invalid signature");\r
+    }\r
+  }\r
+\r
+  /**\r
+   * check that the timestamp is new enough\r
+   */\r
+  private function check_timestamp($timestamp) {\r
+    if( ! $timestamp )\r
+      throw new OAuthException(\r
+        'Missing timestamp parameter. The parameter is required'\r
+      );\r
+    \r
+    // verify that timestamp is recentish\r
+    $now = time();\r
+    if (abs($now - $timestamp) > $this->timestamp_threshold) {\r
+      throw new OAuthException(\r
+        "Expired timestamp, yours $timestamp, ours $now"\r
+      );\r
+    }\r
+  }\r
+\r
+  /**\r
+   * check that the nonce is not repeated\r
+   */\r
+  private function check_nonce($consumer, $token, $nonce, $timestamp) {\r
+    if( ! $nonce )\r
+      throw new OAuthException(\r
+        'Missing nonce parameter. The parameter is required'\r
+      );\r
+\r
+    // verify that the nonce is uniqueish\r
+    $found = $this->data_store->lookup_nonce(\r
+      $consumer,\r
+      $token,\r
+      $nonce,\r
+      $timestamp\r
+    );\r
+    if ($found) {\r
+      throw new OAuthException("Nonce already used: $nonce");\r
+    }\r
+  }\r
+\r
+}\r
+\r
+class OAuthDataStore {\r
+  function lookup_consumer($consumer_key) {\r
+    // implement me\r
+  }\r
+\r
+  function lookup_token($consumer, $token_type, $token) {\r
+    // implement me\r
+  }\r
+\r
+  function lookup_nonce($consumer, $token, $nonce, $timestamp) {\r
+    // implement me\r
+  }\r
+\r
+  function new_request_token($consumer, $callback = null) {\r
+    // return a new token attached to this consumer\r
+  }\r
+\r
+  function new_access_token($token, $consumer, $verifier = null) {\r
+    // return a new access token attached to this consumer\r
+    // for the user associated with this token if the request token\r
+    // is authorized\r
+    // should also invalidate the request token\r
+  }\r
+\r
+}\r
+\r
+class OAuthUtil {\r
+  public static function urlencode_rfc3986($input) {\r
+  if (is_array($input)) {\r
+    return array_map(array('OAuthUtil', 'urlencode_rfc3986'), $input);\r
+  } else if (is_scalar($input)) {\r
+    return str_replace(\r
+      '+',\r
+      ' ',\r
+      str_replace('%7E', '~', rawurlencode($input))\r
+    );\r
+  } else {\r
+    return '';\r
+  }\r
+}\r
+\r
+\r
+  // This decode function isn't taking into consideration the above\r
+  // modifications to the encoding process. However, this method doesn't\r
+  // seem to be used anywhere so leaving it as is.\r
+  public static function urldecode_rfc3986($string) {\r
+    return urldecode($string);\r
+  }\r
+\r
+  // Utility function for turning the Authorization: header into\r
+  // parameters, has to do some unescaping\r
+  // Can filter out any non-oauth parameters if needed (default behaviour)\r
+  public static function split_header($header, $only_allow_oauth_parameters = true) {\r
+    $pattern = '/(([-_a-z]*)=("([^"]*)"|([^,]*)),?)/';\r
+    $offset = 0;\r
+    $params = array();\r
+    while (preg_match($pattern, $header, $matches, PREG_OFFSET_CAPTURE, $offset) > 0) {\r
+      $match = $matches[0];\r
+      $header_name = $matches[2][0];\r
+      $header_content = (isset($matches[5])) ? $matches[5][0] : $matches[4][0];\r
+      if (preg_match('/^oauth_/', $header_name) || !$only_allow_oauth_parameters) {\r
+        $params[$header_name] = OAuthUtil::urldecode_rfc3986($header_content);\r
+      }\r
+      $offset = $match[1] + strlen($match[0]);\r
+    }\r
+\r
+    if (isset($params['realm'])) {\r
+      unset($params['realm']);\r
+    }\r
+\r
+    return $params;\r
+  }\r
+\r
+  // helper to try to sort out headers for people who aren't running apache\r
+  public static function get_headers() {\r
+    if (function_exists('apache_request_headers')) {\r
+      // we need this to get the actual Authorization: header\r
+      // because apache tends to tell us it doesn't exist\r
+      $headers = apache_request_headers();\r
+\r
+      // sanitize the output of apache_request_headers because\r
+      // we always want the keys to be Cased-Like-This and arh()\r
+      // returns the headers in the same case as they are in the\r
+      // request\r
+      $out = array();\r
+      foreach( $headers AS $key => $value ) {\r
+        $key = str_replace(\r
+            " ",\r
+            "-",\r
+            ucwords(strtolower(str_replace("-", " ", $key)))\r
+          );\r
+        $out[$key] = $value;\r
+      }\r
+    } else {\r
+      // otherwise we don't have apache and are just going to have to hope\r
+      // that $_SERVER actually contains what we need\r
+      $out = array();\r
+      if( isset($_SERVER['CONTENT_TYPE']) )\r
+        $out['Content-Type'] = $_SERVER['CONTENT_TYPE'];\r
+      if( isset($_ENV['CONTENT_TYPE']) )\r
+        $out['Content-Type'] = $_ENV['CONTENT_TYPE'];\r
+\r
+      foreach ($_SERVER as $key => $value) {\r
+        if (substr($key, 0, 5) == "HTTP_") {\r
+          // this is chaos, basically it is just there to capitalize the first\r
+          // letter of every word that is not an initial HTTP and strip HTTP\r
+          // code from przemek\r
+          $key = str_replace(\r
+            " ",\r
+            "-",\r
+            ucwords(strtolower(str_replace("_", " ", substr($key, 5))))\r
+          );\r
+          $out[$key] = $value;\r
+        }\r
+      }\r
+    }\r
+    return $out;\r
+  }\r
+\r
+  // This function takes a input like a=b&a=c&d=e and returns the parsed\r
+  // parameters like this\r
+  // array('a' => array('b','c'), 'd' => 'e')\r
+  public static function parse_parameters( $input ) {\r
+    if (!isset($input) || !$input) return array();\r
+\r
+    $pairs = explode('&', $input);\r
+\r
+    $parsed_parameters = array();\r
+    foreach ($pairs as $pair) {\r
+      $split = explode('=', $pair, 2);\r
+      $parameter = OAuthUtil::urldecode_rfc3986($split[0]);\r
+      $value = isset($split[1]) ? OAuthUtil::urldecode_rfc3986($split[1]) : '';\r
+\r
+      if (isset($parsed_parameters[$parameter])) {\r
+        // We have already recieved parameter(s) with this name, so add to the list\r
+        // of parameters with this name\r
+\r
+        if (is_scalar($parsed_parameters[$parameter])) {\r
+          // This is the first duplicate, so transform scalar (string) into an array\r
+          // so we can add the duplicates\r
+          $parsed_parameters[$parameter] = array($parsed_parameters[$parameter]);\r
+        }\r
+\r
+        $parsed_parameters[$parameter][] = $value;\r
+      } else {\r
+        $parsed_parameters[$parameter] = $value;\r
+      }\r
+    }\r
+    return $parsed_parameters;\r
+  }\r
+\r
+  public static function build_http_query($params) {\r
+    if (!$params) return '';\r
+\r
+    // Urlencode both keys and values\r
+    $keys = OAuthUtil::urlencode_rfc3986(array_keys($params));\r
+    $values = OAuthUtil::urlencode_rfc3986(array_values($params));\r
+    $params = array_combine($keys, $values);\r
+\r
+    // Parameters are sorted by name, using lexicographical byte value ordering.\r
+    // Ref: Spec: 9.1.1 (1)\r
+    uksort($params, 'strcmp');\r
+\r
+    $pairs = array();\r
+    foreach ($params as $parameter => $value) {\r
+      if (is_array($value)) {\r
+        // If two or more parameters share the same name, they are sorted by their value\r
+        // Ref: Spec: 9.1.1 (1)\r
+        natsort($value);\r
+        foreach ($value as $duplicate_value) {\r
+          $pairs[] = $parameter . '=' . $duplicate_value;\r
+        }\r
+      } else {\r
+        $pairs[] = $parameter . '=' . $value;\r
+      }\r
+    }\r
+    // For each parameter, the name is separated from the corresponding value by an '=' character (ASCII code 61)\r
+    // Each name-value pair is separated by an '&' character (ASCII code 38)\r
+    return implode('&', $pairs);\r
+  }\r
+}\r
+\r
+?>\r