Reformat library/OAuth1
- Add type hints to Network\FKOAuthDataStore
This commit is contained in:
parent
010a7b7576
commit
17838366a0
2 changed files with 873 additions and 782 deletions
1605
library/OAuth1.php
1605
library/OAuth1.php
|
|
@ -3,65 +3,73 @@
|
||||||
|
|
||||||
/* Generic exception class
|
/* Generic exception class
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
use Friendica\Network\FKOAuthDataStore;
|
||||||
|
|
||||||
if (!class_exists('OAuthException', false)) {
|
if (!class_exists('OAuthException', false)) {
|
||||||
class OAuthException extends Exception
|
class OAuthException extends Exception
|
||||||
{ }
|
{
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class OAuthConsumer
|
class OAuthConsumer
|
||||||
{
|
{
|
||||||
public $key;
|
public $key;
|
||||||
public $secret;
|
public $secret;
|
||||||
|
public $callback_url;
|
||||||
|
|
||||||
function __construct($key, $secret, $callback_url = NULL)
|
function __construct($key, $secret, $callback_url = NULL)
|
||||||
{
|
{
|
||||||
$this->key = $key;
|
$this->key = $key;
|
||||||
$this->secret = $secret;
|
$this->secret = $secret;
|
||||||
$this->callback_url = $callback_url;
|
$this->callback_url = $callback_url;
|
||||||
}
|
}
|
||||||
|
|
||||||
function __toString()
|
function __toString()
|
||||||
{
|
{
|
||||||
return "OAuthConsumer[key=$this->key,secret=$this->secret]";
|
return "OAuthConsumer[key=$this->key,secret=$this->secret]";
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class OAuthToken
|
class OAuthToken
|
||||||
{
|
{
|
||||||
// access tokens and request tokens
|
// access tokens and request tokens
|
||||||
public $key;
|
public $key;
|
||||||
public $secret;
|
public $secret;
|
||||||
|
|
||||||
public $expires;
|
public $expires;
|
||||||
public $scope;
|
public $scope;
|
||||||
public $uid;
|
public $uid;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* key = the token
|
* key = the token
|
||||||
* secret = the token secret
|
* secret = the token secret
|
||||||
*/
|
*
|
||||||
function __construct($key, $secret)
|
* @param $key
|
||||||
{
|
* @param $secret
|
||||||
$this->key = $key;
|
*/
|
||||||
$this->secret = $secret;
|
function __construct($key, $secret)
|
||||||
}
|
{
|
||||||
|
$this->key = $key;
|
||||||
|
$this->secret = $secret;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* generates the basic string serialization of a token that a server
|
* generates the basic string serialization of a token that a server
|
||||||
* would respond to request_token and access_token calls with
|
* would respond to request_token and access_token calls with
|
||||||
*/
|
*/
|
||||||
function to_string()
|
function to_string()
|
||||||
{
|
{
|
||||||
return "oauth_token=" .
|
return "oauth_token=" .
|
||||||
OAuthUtil::urlencode_rfc3986($this->key) .
|
OAuthUtil::urlencode_rfc3986($this->key) .
|
||||||
"&oauth_token_secret=" .
|
"&oauth_token_secret=" .
|
||||||
OAuthUtil::urlencode_rfc3986($this->secret);
|
OAuthUtil::urlencode_rfc3986($this->secret);
|
||||||
}
|
}
|
||||||
|
|
||||||
function __toString()
|
function __toString()
|
||||||
{
|
{
|
||||||
return $this->to_string();
|
return $this->to_string();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -70,37 +78,40 @@ class OAuthToken
|
||||||
*/
|
*/
|
||||||
abstract class OAuthSignatureMethod
|
abstract class OAuthSignatureMethod
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Needs to return the name of the Signature Method (ie HMAC-SHA1)
|
* Needs to return the name of the Signature Method (ie HMAC-SHA1)
|
||||||
* @return string
|
*
|
||||||
*/
|
* @return string
|
||||||
abstract public function get_name();
|
*/
|
||||||
|
abstract public function get_name();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Build up the signature
|
* Build up the signature
|
||||||
* NOTE: The output of this function MUST NOT be urlencoded.
|
* NOTE: The output of this function MUST NOT be urlencoded.
|
||||||
* the encoding is handled in OAuthRequest when the final
|
* the encoding is handled in OAuthRequest when the final
|
||||||
* request is serialized
|
* request is serialized
|
||||||
* @param OAuthRequest $request
|
*
|
||||||
* @param OAuthConsumer $consumer
|
* @param OAuthRequest $request
|
||||||
* @param OAuthToken $token
|
* @param OAuthConsumer $consumer
|
||||||
* @return string
|
* @param OAuthToken $token
|
||||||
*/
|
* @return string
|
||||||
abstract public function build_signature($request, $consumer, $token);
|
*/
|
||||||
|
abstract public function build_signature(OAuthRequest $request, OAuthConsumer $consumer, OAuthToken $token);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Verifies that a given signature is correct
|
* Verifies that a given signature is correct
|
||||||
* @param OAuthRequest $request
|
*
|
||||||
* @param OAuthConsumer $consumer
|
* @param OAuthRequest $request
|
||||||
* @param OAuthToken $token
|
* @param OAuthConsumer $consumer
|
||||||
* @param string $signature
|
* @param OAuthToken $token
|
||||||
* @return bool
|
* @param string $signature
|
||||||
*/
|
* @return bool
|
||||||
public function check_signature($request, $consumer, $token, $signature)
|
*/
|
||||||
{
|
public function check_signature($request, $consumer, $token, $signature)
|
||||||
$built = $this->build_signature($request, $consumer, $token);
|
{
|
||||||
return ($built == $signature);
|
$built = $this->build_signature($request, $consumer, $token);
|
||||||
}
|
return ($built == $signature);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -112,28 +123,34 @@ abstract class OAuthSignatureMethod
|
||||||
*/
|
*/
|
||||||
class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod
|
class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod
|
||||||
{
|
{
|
||||||
function get_name()
|
function get_name()
|
||||||
{
|
{
|
||||||
return "HMAC-SHA1";
|
return "HMAC-SHA1";
|
||||||
}
|
}
|
||||||
|
|
||||||
public function build_signature($request, $consumer, $token)
|
/**
|
||||||
{
|
* @param OAuthRequest $request
|
||||||
$base_string = $request->get_signature_base_string();
|
* @param OAuthConsumer $consumer
|
||||||
$request->base_string = $base_string;
|
* @param OAuthToken $token
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function build_signature(OAuthRequest $request, OAuthConsumer $consumer, OAuthToken $token)
|
||||||
|
{
|
||||||
|
$base_string = $request->get_signature_base_string();
|
||||||
|
$request->base_string = $base_string;
|
||||||
|
|
||||||
$key_parts = array(
|
$key_parts = array(
|
||||||
$consumer->secret,
|
$consumer->secret,
|
||||||
($token) ? $token->secret : ""
|
($token) ? $token->secret : ""
|
||||||
);
|
);
|
||||||
|
|
||||||
$key_parts = OAuthUtil::urlencode_rfc3986($key_parts);
|
$key_parts = OAuthUtil::urlencode_rfc3986($key_parts);
|
||||||
$key = implode('&', $key_parts);
|
$key = implode('&', $key_parts);
|
||||||
|
|
||||||
|
|
||||||
$r = base64_encode(hash_hmac('sha1', $base_string, $key, true));
|
$r = base64_encode(hash_hmac('sha1', $base_string, $key, true));
|
||||||
return $r;
|
return $r;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -143,33 +160,38 @@ class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod
|
||||||
*/
|
*/
|
||||||
class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod
|
class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod
|
||||||
{
|
{
|
||||||
public function get_name()
|
public function get_name()
|
||||||
{
|
{
|
||||||
return "PLAINTEXT";
|
return "PLAINTEXT";
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* oauth_signature is set to the concatenated encoded values of the Consumer Secret and
|
* oauth_signature is set to the concatenated encoded values of the Consumer Secret and
|
||||||
* Token Secret, separated by a '&' character (ASCII code 38), even if either secret is
|
* Token Secret, separated by a '&' character (ASCII code 38), even if either secret is
|
||||||
* empty. The result MUST be encoded again.
|
* empty. The result MUST be encoded again.
|
||||||
* - Chapter 9.4.1 ("Generating Signatures")
|
* - Chapter 9.4.1 ("Generating Signatures")
|
||||||
*
|
*
|
||||||
* Please note that the second encoding MUST NOT happen in the SignatureMethod, as
|
* Please note that the second encoding MUST NOT happen in the SignatureMethod, as
|
||||||
* OAuthRequest handles this!
|
* OAuthRequest handles this!
|
||||||
*/
|
*
|
||||||
public function build_signature($request, $consumer, $token)
|
* @param $request
|
||||||
{
|
* @param $consumer
|
||||||
$key_parts = array(
|
* @param $token
|
||||||
$consumer->secret,
|
* @return string
|
||||||
($token) ? $token->secret : ""
|
*/
|
||||||
);
|
public function build_signature(OAuthRequest $request, OAuthConsumer $consumer, OAuthToken $token)
|
||||||
|
{
|
||||||
|
$key_parts = array(
|
||||||
|
$consumer->secret,
|
||||||
|
($token) ? $token->secret : ""
|
||||||
|
);
|
||||||
|
|
||||||
$key_parts = OAuthUtil::urlencode_rfc3986($key_parts);
|
$key_parts = OAuthUtil::urlencode_rfc3986($key_parts);
|
||||||
$key = implode('&', $key_parts);
|
$key = implode('&', $key_parts);
|
||||||
$request->base_string = $key;
|
$request->base_string = $key;
|
||||||
|
|
||||||
return $key;
|
return $key;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -182,774 +204,841 @@ class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod
|
||||||
*/
|
*/
|
||||||
abstract class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod
|
abstract class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod
|
||||||
{
|
{
|
||||||
public function get_name()
|
public function get_name()
|
||||||
{
|
{
|
||||||
return "RSA-SHA1";
|
return "RSA-SHA1";
|
||||||
}
|
}
|
||||||
|
|
||||||
// Up to the SP to implement this lookup of keys. Possible ideas are:
|
// Up to the SP to implement this lookup of keys. Possible ideas are:
|
||||||
// (1) do a lookup in a table of trusted certs keyed off of consumer
|
// (1) do a lookup in a table of trusted certs keyed off of consumer
|
||||||
// (2) fetch via http using a url provided by the requester
|
// (2) fetch via http using a url provided by the requester
|
||||||
// (3) some sort of specific discovery code based on request
|
// (3) some sort of specific discovery code based on request
|
||||||
//
|
//
|
||||||
// Either way should return a string representation of the certificate
|
// Either way should return a string representation of the certificate
|
||||||
protected abstract function fetch_public_cert(&$request);
|
protected abstract function fetch_public_cert(&$request);
|
||||||
|
|
||||||
// Up to the SP to implement this lookup of keys. Possible ideas are:
|
// Up to the SP to implement this lookup of keys. Possible ideas are:
|
||||||
// (1) do a lookup in a table of trusted certs keyed off of consumer
|
// (1) do a lookup in a table of trusted certs keyed off of consumer
|
||||||
//
|
//
|
||||||
// Either way should return a string representation of the certificate
|
// Either way should return a string representation of the certificate
|
||||||
protected abstract function fetch_private_cert(&$request);
|
protected abstract function fetch_private_cert(&$request);
|
||||||
|
|
||||||
public function build_signature($request, $consumer, $token)
|
public function build_signature(OAuthRequest $request, OAuthConsumer $consumer, OAuthToken $token)
|
||||||
{
|
{
|
||||||
$base_string = $request->get_signature_base_string();
|
$base_string = $request->get_signature_base_string();
|
||||||
$request->base_string = $base_string;
|
$request->base_string = $base_string;
|
||||||
|
|
||||||
// Fetch the private key cert based on the request
|
// Fetch the private key cert based on the request
|
||||||
$cert = $this->fetch_private_cert($request);
|
$cert = $this->fetch_private_cert($request);
|
||||||
|
|
||||||
// Pull the private key ID from the certificate
|
// Pull the private key ID from the certificate
|
||||||
$privatekeyid = openssl_get_privatekey($cert);
|
$privatekeyid = openssl_get_privatekey($cert);
|
||||||
|
|
||||||
// Sign using the key
|
// Sign using the key
|
||||||
$ok = openssl_sign($base_string, $signature, $privatekeyid);
|
openssl_sign($base_string, $signature, $privatekeyid);
|
||||||
|
|
||||||
// Release the key resource
|
// Release the key resource
|
||||||
openssl_free_key($privatekeyid);
|
openssl_free_key($privatekeyid);
|
||||||
|
|
||||||
return base64_encode($signature);
|
return base64_encode($signature);
|
||||||
}
|
}
|
||||||
|
|
||||||
public function check_signature($request, $consumer, $token, $signature)
|
public function check_signature($request, $consumer, $token, $signature)
|
||||||
{
|
{
|
||||||
$decoded_sig = base64_decode($signature);
|
$decoded_sig = base64_decode($signature);
|
||||||
|
|
||||||
$base_string = $request->get_signature_base_string();
|
$base_string = $request->get_signature_base_string();
|
||||||
|
|
||||||
// Fetch the public key cert based on the request
|
// Fetch the public key cert based on the request
|
||||||
$cert = $this->fetch_public_cert($request);
|
$cert = $this->fetch_public_cert($request);
|
||||||
|
|
||||||
// Pull the public key ID from the certificate
|
// Pull the public key ID from the certificate
|
||||||
$publickeyid = openssl_get_publickey($cert);
|
$publickeyid = openssl_get_publickey($cert);
|
||||||
|
|
||||||
// Check the computed signature against the one passed in the query
|
// Check the computed signature against the one passed in the query
|
||||||
$ok = openssl_verify($base_string, $decoded_sig, $publickeyid);
|
$ok = openssl_verify($base_string, $decoded_sig, $publickeyid);
|
||||||
|
|
||||||
// Release the key resource
|
// Release the key resource
|
||||||
openssl_free_key($publickeyid);
|
openssl_free_key($publickeyid);
|
||||||
|
|
||||||
return $ok == 1;
|
return $ok == 1;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class OAuthRequest
|
class OAuthRequest
|
||||||
{
|
{
|
||||||
private $parameters;
|
private $parameters;
|
||||||
private $http_method;
|
private $http_method;
|
||||||
private $http_url;
|
private $http_url;
|
||||||
// for debug purposes
|
// for debug purposes
|
||||||
public $base_string;
|
public $base_string;
|
||||||
public static $version = '1.0';
|
public static $version = '1.0';
|
||||||
public static $POST_INPUT = 'php://input';
|
public static $POST_INPUT = 'php://input';
|
||||||
|
|
||||||
function __construct($http_method, $http_url, $parameters = NULL)
|
function __construct($http_method, $http_url, $parameters = NULL)
|
||||||
{
|
{
|
||||||
@$parameters or $parameters = array();
|
@$parameters or $parameters = array();
|
||||||
$parameters = array_merge(OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters);
|
$parameters = array_merge(OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters);
|
||||||
$this->parameters = $parameters;
|
$this->parameters = $parameters;
|
||||||
$this->http_method = $http_method;
|
$this->http_method = $http_method;
|
||||||
$this->http_url = $http_url;
|
$this->http_url = $http_url;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* attempt to build up a request from what was passed to the server
|
* attempt to build up a request from what was passed to the server
|
||||||
*/
|
*
|
||||||
public static function from_request($http_method = NULL, $http_url = NULL, $parameters = NULL)
|
* @param string|null $http_method
|
||||||
{
|
* @param string|null $http_url
|
||||||
$scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on")
|
* @param string|null $parameters
|
||||||
? 'http'
|
* @return OAuthRequest
|
||||||
: 'https';
|
*/
|
||||||
@$http_url or $http_url = $scheme .
|
public static function from_request($http_method = NULL, $http_url = NULL, $parameters = NULL)
|
||||||
'://' . $_SERVER['HTTP_HOST'] .
|
{
|
||||||
':' .
|
$scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on")
|
||||||
$_SERVER['SERVER_PORT'] .
|
? 'http'
|
||||||
$_SERVER['REQUEST_URI'];
|
: 'https';
|
||||||
@$http_method or $http_method = $_SERVER['REQUEST_METHOD'];
|
@$http_url or $http_url = $scheme .
|
||||||
|
'://' . $_SERVER['HTTP_HOST'] .
|
||||||
|
':' .
|
||||||
|
$_SERVER['SERVER_PORT'] .
|
||||||
|
$_SERVER['REQUEST_URI'];
|
||||||
|
@$http_method or $http_method = $_SERVER['REQUEST_METHOD'];
|
||||||
|
|
||||||
// We weren't handed any parameters, so let's find the ones relevant to
|
// We weren't handed any parameters, so let's find the ones relevant to
|
||||||
// this request.
|
// this request.
|
||||||
// If you run XML-RPC or similar you should use this to provide your own
|
// If you run XML-RPC or similar you should use this to provide your own
|
||||||
// parsed parameter-list
|
// parsed parameter-list
|
||||||
if (!$parameters) {
|
if (!$parameters) {
|
||||||
// Find request headers
|
// Find request headers
|
||||||
$request_headers = OAuthUtil::get_headers();
|
$request_headers = OAuthUtil::get_headers();
|
||||||
|
|
||||||
// Parse the query-string to find GET parameters
|
// Parse the query-string to find GET parameters
|
||||||
$parameters = OAuthUtil::parse_parameters($_SERVER['QUERY_STRING']);
|
$parameters = OAuthUtil::parse_parameters($_SERVER['QUERY_STRING']);
|
||||||
|
|
||||||
// It's a POST request of the proper content-type, so parse POST
|
// It's a POST request of the proper content-type, so parse POST
|
||||||
// parameters and add those overriding any duplicates from GET
|
// parameters and add those overriding any duplicates from GET
|
||||||
if (
|
if (
|
||||||
$http_method == "POST"
|
$http_method == "POST"
|
||||||
&& @strstr(
|
&& @strstr(
|
||||||
$request_headers["Content-Type"],
|
$request_headers["Content-Type"],
|
||||||
"application/x-www-form-urlencoded"
|
"application/x-www-form-urlencoded"
|
||||||
)
|
)
|
||||||
) {
|
) {
|
||||||
$post_data = OAuthUtil::parse_parameters(
|
$post_data = OAuthUtil::parse_parameters(
|
||||||
file_get_contents(self::$POST_INPUT)
|
file_get_contents(self::$POST_INPUT)
|
||||||
);
|
);
|
||||||
$parameters = array_merge($parameters, $post_data);
|
$parameters = array_merge($parameters, $post_data);
|
||||||
}
|
}
|
||||||
|
|
||||||
// We have a Authorization-header with OAuth data. Parse the header
|
// We have a Authorization-header with OAuth data. Parse the header
|
||||||
// and add those overriding any duplicates from GET or POST
|
// and add those overriding any duplicates from GET or POST
|
||||||
if (@substr($request_headers['Authorization'], 0, 6) == "OAuth ") {
|
if (@substr($request_headers['Authorization'], 0, 6) == "OAuth ") {
|
||||||
$header_parameters = OAuthUtil::split_header(
|
$header_parameters = OAuthUtil::split_header(
|
||||||
$request_headers['Authorization']
|
$request_headers['Authorization']
|
||||||
);
|
);
|
||||||
$parameters = array_merge($parameters, $header_parameters);
|
$parameters = array_merge($parameters, $header_parameters);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// fix for friendica redirect system
|
// fix for friendica redirect system
|
||||||
|
|
||||||
$http_url = substr($http_url, 0, strpos($http_url, $parameters['pagename']) + strlen($parameters['pagename']));
|
$http_url = substr($http_url, 0, strpos($http_url, $parameters['pagename']) + strlen($parameters['pagename']));
|
||||||
unset($parameters['pagename']);
|
unset($parameters['pagename']);
|
||||||
|
|
||||||
return new OAuthRequest($http_method, $http_url, $parameters);
|
return new OAuthRequest($http_method, $http_url, $parameters);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* pretty much a helper function to set up the request
|
* pretty much a helper function to set up the request
|
||||||
*/
|
*
|
||||||
public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters = NULL)
|
* @param OAuthConsumer $consumer
|
||||||
{
|
* @param OAuthToken $token
|
||||||
@$parameters or $parameters = array();
|
* @param string $http_method
|
||||||
$defaults = array(
|
* @param string $http_url
|
||||||
"oauth_version" => OAuthRequest::$version,
|
* @param array|null $parameters
|
||||||
"oauth_nonce" => OAuthRequest::generate_nonce(),
|
* @return OAuthRequest
|
||||||
"oauth_timestamp" => OAuthRequest::generate_timestamp(),
|
*/
|
||||||
"oauth_consumer_key" => $consumer->key
|
public static function from_consumer_and_token(OAuthConsumer $consumer, OAuthToken $token, $http_method, $http_url, array $parameters = NULL)
|
||||||
);
|
{
|
||||||
if ($token)
|
@$parameters or $parameters = array();
|
||||||
$defaults['oauth_token'] = $token->key;
|
$defaults = array(
|
||||||
|
"oauth_version" => OAuthRequest::$version,
|
||||||
|
"oauth_nonce" => OAuthRequest::generate_nonce(),
|
||||||
|
"oauth_timestamp" => OAuthRequest::generate_timestamp(),
|
||||||
|
"oauth_consumer_key" => $consumer->key
|
||||||
|
);
|
||||||
|
if ($token)
|
||||||
|
$defaults['oauth_token'] = $token->key;
|
||||||
|
|
||||||
$parameters = array_merge($defaults, $parameters);
|
$parameters = array_merge($defaults, $parameters);
|
||||||
|
|
||||||
return new OAuthRequest($http_method, $http_url, $parameters);
|
return new OAuthRequest($http_method, $http_url, $parameters);
|
||||||
}
|
}
|
||||||
|
|
||||||
public function set_parameter($name, $value, $allow_duplicates = true)
|
public function set_parameter($name, $value, $allow_duplicates = true)
|
||||||
{
|
{
|
||||||
if ($allow_duplicates && isset($this->parameters[$name])) {
|
if ($allow_duplicates && isset($this->parameters[$name])) {
|
||||||
// We have already added parameter(s) with this name, so add to the list
|
// We have already added parameter(s) with this name, so add to the list
|
||||||
if (is_scalar($this->parameters[$name])) {
|
if (is_scalar($this->parameters[$name])) {
|
||||||
// This is the first duplicate, so transform scalar (string)
|
// This is the first duplicate, so transform scalar (string)
|
||||||
// into an array so we can add the duplicates
|
// into an array so we can add the duplicates
|
||||||
$this->parameters[$name] = array($this->parameters[$name]);
|
$this->parameters[$name] = array($this->parameters[$name]);
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->parameters[$name][] = $value;
|
$this->parameters[$name][] = $value;
|
||||||
} else {
|
} else {
|
||||||
$this->parameters[$name] = $value;
|
$this->parameters[$name] = $value;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public function get_parameter($name)
|
public function get_parameter($name)
|
||||||
{
|
{
|
||||||
return isset($this->parameters[$name]) ? $this->parameters[$name] : null;
|
return isset($this->parameters[$name]) ? $this->parameters[$name] : null;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function get_parameters()
|
public function get_parameters()
|
||||||
{
|
{
|
||||||
return $this->parameters;
|
return $this->parameters;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function unset_parameter($name)
|
public function unset_parameter($name)
|
||||||
{
|
{
|
||||||
unset($this->parameters[$name]);
|
unset($this->parameters[$name]);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The request parameters, sorted and concatenated into a normalized string.
|
* The request parameters, sorted and concatenated into a normalized string.
|
||||||
* @return string
|
*
|
||||||
*/
|
* @return string
|
||||||
public function get_signable_parameters()
|
*/
|
||||||
{
|
public function get_signable_parameters()
|
||||||
// Grab all parameters
|
{
|
||||||
$params = $this->parameters;
|
// Grab all parameters
|
||||||
|
$params = $this->parameters;
|
||||||
|
|
||||||
// Remove oauth_signature if present
|
// Remove oauth_signature if present
|
||||||
// Ref: Spec: 9.1.1 ("The oauth_signature parameter MUST be excluded.")
|
// Ref: Spec: 9.1.1 ("The oauth_signature parameter MUST be excluded.")
|
||||||
if (isset($params['oauth_signature'])) {
|
if (isset($params['oauth_signature'])) {
|
||||||
unset($params['oauth_signature']);
|
unset($params['oauth_signature']);
|
||||||
}
|
}
|
||||||
|
|
||||||
return OAuthUtil::build_http_query($params);
|
return OAuthUtil::build_http_query($params);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the base string of this request
|
* Returns the base string of this request
|
||||||
*
|
*
|
||||||
* The base string defined as the method, the url
|
* The base string defined as the method, the url
|
||||||
* and the parameters (normalized), each urlencoded
|
* and the parameters (normalized), each urlencoded
|
||||||
* and the concated with &.
|
* and the concated with &.
|
||||||
*/
|
*/
|
||||||
public function get_signature_base_string()
|
public function get_signature_base_string()
|
||||||
{
|
{
|
||||||
$parts = array(
|
$parts = array(
|
||||||
$this->get_normalized_http_method(),
|
$this->get_normalized_http_method(),
|
||||||
$this->get_normalized_http_url(),
|
$this->get_normalized_http_url(),
|
||||||
$this->get_signable_parameters()
|
$this->get_signable_parameters()
|
||||||
);
|
);
|
||||||
|
|
||||||
$parts = OAuthUtil::urlencode_rfc3986($parts);
|
$parts = OAuthUtil::urlencode_rfc3986($parts);
|
||||||
|
|
||||||
return implode('&', $parts);
|
return implode('&', $parts);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* just uppercases the http method
|
* just uppercases the http method
|
||||||
*/
|
*/
|
||||||
public function get_normalized_http_method()
|
public function get_normalized_http_method()
|
||||||
{
|
{
|
||||||
return strtoupper($this->http_method);
|
return strtoupper($this->http_method);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* parses the url and rebuilds it to be
|
* parses the url and rebuilds it to be
|
||||||
* scheme://host/path
|
* scheme://host/path
|
||||||
*/
|
*/
|
||||||
public function get_normalized_http_url()
|
public function get_normalized_http_url()
|
||||||
{
|
{
|
||||||
$parts = parse_url($this->http_url);
|
$parts = parse_url($this->http_url);
|
||||||
|
|
||||||
$port = @$parts['port'];
|
$port = @$parts['port'];
|
||||||
$scheme = $parts['scheme'];
|
$scheme = $parts['scheme'];
|
||||||
$host = $parts['host'];
|
$host = $parts['host'];
|
||||||
$path = @$parts['path'];
|
$path = @$parts['path'];
|
||||||
|
|
||||||
$port or $port = ($scheme == 'https') ? '443' : '80';
|
$port or $port = ($scheme == 'https') ? '443' : '80';
|
||||||
|
|
||||||
if (($scheme == 'https' && $port != '443')
|
if (($scheme == 'https' && $port != '443')
|
||||||
|| ($scheme == 'http' && $port != '80')
|
|| ($scheme == 'http' && $port != '80')
|
||||||
) {
|
) {
|
||||||
$host = "$host:$port";
|
$host = "$host:$port";
|
||||||
}
|
}
|
||||||
return "$scheme://$host$path";
|
return "$scheme://$host$path";
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* builds a url usable for a GET request
|
* builds a url usable for a GET request
|
||||||
*/
|
*/
|
||||||
public function to_url()
|
public function to_url()
|
||||||
{
|
{
|
||||||
$post_data = $this->to_postdata();
|
$post_data = $this->to_postdata();
|
||||||
$out = $this->get_normalized_http_url();
|
$out = $this->get_normalized_http_url();
|
||||||
if ($post_data) {
|
if ($post_data) {
|
||||||
$out .= '?' . $post_data;
|
$out .= '?' . $post_data;
|
||||||
}
|
}
|
||||||
return $out;
|
return $out;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* builds the data one would send in a POST request
|
* builds the data one would send in a POST request
|
||||||
*/
|
*
|
||||||
public function to_postdata($raw = false)
|
* @param bool $raw
|
||||||
{
|
* @return array|string
|
||||||
if ($raw)
|
*/
|
||||||
return $this->parameters;
|
public function to_postdata(bool $raw = false)
|
||||||
else
|
{
|
||||||
return OAuthUtil::build_http_query($this->parameters);
|
if ($raw)
|
||||||
}
|
return $this->parameters;
|
||||||
|
else
|
||||||
|
return OAuthUtil::build_http_query($this->parameters);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* builds the Authorization: header
|
* builds the Authorization: header
|
||||||
*/
|
*
|
||||||
public function to_header($realm = null)
|
* @param string|null $realm
|
||||||
{
|
* @return string
|
||||||
$first = true;
|
* @throws OAuthException
|
||||||
if ($realm) {
|
*/
|
||||||
$out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"';
|
public function to_header($realm = null)
|
||||||
$first = false;
|
{
|
||||||
} else
|
$first = true;
|
||||||
$out = 'Authorization: OAuth';
|
if ($realm) {
|
||||||
|
$out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"';
|
||||||
|
$first = false;
|
||||||
|
} else
|
||||||
|
$out = 'Authorization: OAuth';
|
||||||
|
|
||||||
foreach ($this->parameters as $k => $v) {
|
foreach ($this->parameters as $k => $v) {
|
||||||
if (substr($k, 0, 5) != "oauth") continue;
|
if (substr($k, 0, 5) != "oauth") continue;
|
||||||
if (is_array($v)) {
|
if (is_array($v)) {
|
||||||
throw new OAuthException('Arrays not supported in headers');
|
throw new OAuthException('Arrays not supported in headers');
|
||||||
}
|
}
|
||||||
$out .= ($first) ? ' ' : ',';
|
$out .= ($first) ? ' ' : ',';
|
||||||
$out .= OAuthUtil::urlencode_rfc3986($k) .
|
$out .= OAuthUtil::urlencode_rfc3986($k) .
|
||||||
'="' .
|
'="' .
|
||||||
OAuthUtil::urlencode_rfc3986($v) .
|
OAuthUtil::urlencode_rfc3986($v) .
|
||||||
'"';
|
'"';
|
||||||
$first = false;
|
$first = false;
|
||||||
}
|
}
|
||||||
return $out;
|
return $out;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function __toString()
|
public function __toString()
|
||||||
{
|
{
|
||||||
return $this->to_url();
|
return $this->to_url();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
public function sign_request($signature_method, $consumer, $token)
|
public function sign_request(OAuthSignatureMethod $signature_method, $consumer, $token)
|
||||||
{
|
{
|
||||||
$this->set_parameter(
|
$this->set_parameter(
|
||||||
"oauth_signature_method",
|
"oauth_signature_method",
|
||||||
$signature_method->get_name(),
|
$signature_method->get_name(),
|
||||||
false
|
false
|
||||||
);
|
);
|
||||||
$signature = $this->build_signature($signature_method, $consumer, $token);
|
$signature = $this->build_signature($signature_method, $consumer, $token);
|
||||||
$this->set_parameter("oauth_signature", $signature, false);
|
$this->set_parameter("oauth_signature", $signature, false);
|
||||||
}
|
}
|
||||||
|
|
||||||
public function build_signature($signature_method, $consumer, $token)
|
public function build_signature(OAuthSignatureMethod $signature_method, $consumer, $token)
|
||||||
{
|
{
|
||||||
$signature = $signature_method->build_signature($this, $consumer, $token);
|
$signature = $signature_method->build_signature($this, $consumer, $token);
|
||||||
return $signature;
|
return $signature;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* util function: current timestamp
|
* util function: current timestamp
|
||||||
*/
|
*/
|
||||||
private static function generate_timestamp()
|
private static function generate_timestamp()
|
||||||
{
|
{
|
||||||
return time();
|
return time();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* util function: current nonce
|
* util function: current nonce
|
||||||
*/
|
*/
|
||||||
private static function generate_nonce()
|
private static function generate_nonce()
|
||||||
{
|
{
|
||||||
return Friendica\Util\Strings::getRandomHex(32);
|
return Friendica\Util\Strings::getRandomHex(32);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class OAuthServer
|
class OAuthServer
|
||||||
{
|
{
|
||||||
protected $timestamp_threshold = 300; // in seconds, five minutes
|
protected $timestamp_threshold = 300; // in seconds, five minutes
|
||||||
protected $version = '1.0'; // hi blaine
|
protected $version = '1.0'; // hi blaine
|
||||||
protected $signature_methods = array();
|
/** @var OAuthSignatureMethod[] */
|
||||||
|
protected $signature_methods = array();
|
||||||
|
|
||||||
protected $data_store;
|
/** @var FKOAuthDataStore */
|
||||||
|
protected $data_store;
|
||||||
|
|
||||||
function __construct($data_store)
|
function __construct(FKOAuthDataStore $data_store)
|
||||||
{
|
{
|
||||||
$this->data_store = $data_store;
|
$this->data_store = $data_store;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function add_signature_method($signature_method)
|
public function add_signature_method(OAuthSignatureMethod $signature_method)
|
||||||
{
|
{
|
||||||
$this->signature_methods[$signature_method->get_name()] =
|
$this->signature_methods[$signature_method->get_name()] =
|
||||||
$signature_method;
|
$signature_method;
|
||||||
}
|
}
|
||||||
|
|
||||||
// high level functions
|
// high level functions
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* process a request_token request
|
* process a request_token request
|
||||||
* returns the request token on success
|
* returns the request token on success
|
||||||
*/
|
*
|
||||||
public function fetch_request_token(&$request)
|
* @param OAuthRequest $request
|
||||||
{
|
* @return OAuthToken|null
|
||||||
$this->get_version($request);
|
* @throws OAuthException
|
||||||
|
*/
|
||||||
|
public function fetch_request_token(OAuthRequest $request)
|
||||||
|
{
|
||||||
|
$this->get_version($request);
|
||||||
|
|
||||||
$consumer = $this->get_consumer($request);
|
$consumer = $this->get_consumer($request);
|
||||||
|
|
||||||
// no token required for the initial token request
|
// no token required for the initial token request
|
||||||
$token = NULL;
|
$token = NULL;
|
||||||
|
|
||||||
$this->check_signature($request, $consumer, $token);
|
$this->check_signature($request, $consumer, $token);
|
||||||
|
|
||||||
// Rev A change
|
// Rev A change
|
||||||
$callback = $request->get_parameter('oauth_callback');
|
$callback = $request->get_parameter('oauth_callback');
|
||||||
$new_token = $this->data_store->new_request_token($consumer, $callback);
|
$new_token = $this->data_store->new_request_token($consumer, $callback);
|
||||||
|
|
||||||
return $new_token;
|
return $new_token;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* process an access_token request
|
* process an access_token request
|
||||||
* returns the access token on success
|
* returns the access token on success
|
||||||
*/
|
*
|
||||||
public function fetch_access_token(&$request)
|
* @param OAuthRequest $request
|
||||||
{
|
* @return object
|
||||||
$this->get_version($request);
|
* @throws OAuthException
|
||||||
|
*/
|
||||||
|
public function fetch_access_token(OAuthRequest $request)
|
||||||
|
{
|
||||||
|
$this->get_version($request);
|
||||||
|
|
||||||
$consumer = $this->get_consumer($request);
|
$consumer = $this->get_consumer($request);
|
||||||
|
|
||||||
// requires authorized request token
|
// requires authorized request token
|
||||||
$token = $this->get_token($request, $consumer, "request");
|
$token = $this->get_token($request, $consumer, "request");
|
||||||
|
|
||||||
$this->check_signature($request, $consumer, $token);
|
$this->check_signature($request, $consumer, $token);
|
||||||
|
|
||||||
// Rev A change
|
// Rev A change
|
||||||
$verifier = $request->get_parameter('oauth_verifier');
|
$verifier = $request->get_parameter('oauth_verifier');
|
||||||
$new_token = $this->data_store->new_access_token($token, $consumer, $verifier);
|
$new_token = $this->data_store->new_access_token($token, $consumer, $verifier);
|
||||||
|
|
||||||
return $new_token;
|
return $new_token;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* verify an api call, checks all the parameters
|
* verify an api call, checks all the parameters
|
||||||
*/
|
*
|
||||||
public function verify_request(&$request)
|
* @param OAuthRequest $request
|
||||||
{
|
* @return array
|
||||||
$this->get_version($request);
|
* @throws OAuthException
|
||||||
$consumer = $this->get_consumer($request);
|
*/
|
||||||
$token = $this->get_token($request, $consumer, "access");
|
public function verify_request(OAuthRequest $request)
|
||||||
$this->check_signature($request, $consumer, $token);
|
{
|
||||||
return [$consumer, $token];
|
$this->get_version($request);
|
||||||
}
|
$consumer = $this->get_consumer($request);
|
||||||
|
$token = $this->get_token($request, $consumer, "access");
|
||||||
|
$this->check_signature($request, $consumer, $token);
|
||||||
|
return [$consumer, $token];
|
||||||
|
}
|
||||||
|
|
||||||
// Internals from here
|
// Internals from here
|
||||||
/**
|
|
||||||
* version 1
|
|
||||||
*/
|
|
||||||
private function get_version(&$request)
|
|
||||||
{
|
|
||||||
$version = $request->get_parameter("oauth_version");
|
|
||||||
if (!$version) {
|
|
||||||
// Service Providers MUST assume the protocol version to be 1.0 if this parameter is not present.
|
|
||||||
// Chapter 7.0 ("Accessing Protected Ressources")
|
|
||||||
$version = '1.0';
|
|
||||||
}
|
|
||||||
if ($version !== $this->version) {
|
|
||||||
throw new OAuthException("OAuth version '$version' not supported");
|
|
||||||
}
|
|
||||||
return $version;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* figure out the signature with some defaults
|
* version 1
|
||||||
*/
|
*
|
||||||
private function get_signature_method(&$request)
|
* @param OAuthRequest $request
|
||||||
{
|
* @return string
|
||||||
$signature_method =
|
* @throws OAuthException
|
||||||
@$request->get_parameter("oauth_signature_method");
|
*/
|
||||||
|
private function get_version(OAuthRequest $request)
|
||||||
|
{
|
||||||
|
$version = $request->get_parameter("oauth_version");
|
||||||
|
if (!$version) {
|
||||||
|
// Service Providers MUST assume the protocol version to be 1.0 if this parameter is not present.
|
||||||
|
// Chapter 7.0 ("Accessing Protected Ressources")
|
||||||
|
$version = '1.0';
|
||||||
|
}
|
||||||
|
if ($version !== $this->version) {
|
||||||
|
throw new OAuthException("OAuth version '$version' not supported");
|
||||||
|
}
|
||||||
|
return $version;
|
||||||
|
}
|
||||||
|
|
||||||
if (!$signature_method) {
|
/**
|
||||||
// According to chapter 7 ("Accessing Protected Ressources") the signature-method
|
* figure out the signature with some defaults
|
||||||
// parameter is required, and we can't just fallback to PLAINTEXT
|
*
|
||||||
throw new OAuthException('No signature method parameter. This parameter is required');
|
* @param OAuthRequest $request
|
||||||
}
|
* @return OAuthSignatureMethod
|
||||||
|
* @throws OAuthException
|
||||||
|
*/
|
||||||
|
private function get_signature_method(OAuthRequest $request)
|
||||||
|
{
|
||||||
|
$signature_method =
|
||||||
|
@$request->get_parameter("oauth_signature_method");
|
||||||
|
|
||||||
if (!in_array(
|
if (!$signature_method) {
|
||||||
$signature_method,
|
// According to chapter 7 ("Accessing Protected Ressources") the signature-method
|
||||||
array_keys($this->signature_methods)
|
// parameter is required, and we can't just fallback to PLAINTEXT
|
||||||
)) {
|
throw new OAuthException('No signature method parameter. This parameter is required');
|
||||||
throw new OAuthException(
|
}
|
||||||
"Signature method '$signature_method' not supported " .
|
|
||||||
"try one of the following: " .
|
|
||||||
implode(", ", array_keys($this->signature_methods))
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return $this->signature_methods[$signature_method];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
if (!in_array(
|
||||||
* try to find the consumer for the provided request's consumer key
|
$signature_method,
|
||||||
*/
|
array_keys($this->signature_methods)
|
||||||
private function get_consumer(&$request)
|
)) {
|
||||||
{
|
throw new OAuthException(
|
||||||
$consumer_key = @$request->get_parameter("oauth_consumer_key");
|
"Signature method '$signature_method' not supported " .
|
||||||
if (!$consumer_key) {
|
"try one of the following: " .
|
||||||
throw new OAuthException("Invalid consumer key");
|
implode(", ", array_keys($this->signature_methods))
|
||||||
}
|
);
|
||||||
|
}
|
||||||
|
return $this->signature_methods[$signature_method];
|
||||||
|
}
|
||||||
|
|
||||||
$consumer = $this->data_store->lookup_consumer($consumer_key);
|
/**
|
||||||
if (!$consumer) {
|
* try to find the consumer for the provided request's consumer key
|
||||||
throw new OAuthException("Invalid consumer");
|
*
|
||||||
}
|
* @param OAuthRequest $request
|
||||||
|
* @return OAuthConsumer
|
||||||
|
* @throws OAuthException
|
||||||
|
*/
|
||||||
|
private function get_consumer(OAuthRequest $request)
|
||||||
|
{
|
||||||
|
$consumer_key = @$request->get_parameter("oauth_consumer_key");
|
||||||
|
if (!$consumer_key) {
|
||||||
|
throw new OAuthException("Invalid consumer key");
|
||||||
|
}
|
||||||
|
|
||||||
return $consumer;
|
$consumer = $this->data_store->lookup_consumer($consumer_key);
|
||||||
}
|
if (!$consumer) {
|
||||||
|
throw new OAuthException("Invalid consumer");
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
return $consumer;
|
||||||
* try to find the token for the provided request's token key
|
}
|
||||||
*/
|
|
||||||
private function get_token(&$request, $consumer, $token_type = "access")
|
|
||||||
{
|
|
||||||
$token_field = @$request->get_parameter('oauth_token');
|
|
||||||
$token = $this->data_store->lookup_token(
|
|
||||||
$consumer,
|
|
||||||
$token_type,
|
|
||||||
$token_field
|
|
||||||
);
|
|
||||||
if (!$token) {
|
|
||||||
throw new OAuthException("Invalid $token_type token: $token_field");
|
|
||||||
}
|
|
||||||
return $token;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* all-in-one function to check the signature on a request
|
* try to find the token for the provided request's token key
|
||||||
* should guess the signature method appropriately
|
*
|
||||||
*/
|
* @param OAuthRequest $request
|
||||||
private function check_signature(&$request, $consumer, $token)
|
* @param $consumer
|
||||||
{
|
* @param string $token_type
|
||||||
// this should probably be in a different method
|
* @return OAuthToken|null
|
||||||
$timestamp = @$request->get_parameter('oauth_timestamp');
|
* @throws OAuthException
|
||||||
$nonce = @$request->get_parameter('oauth_nonce');
|
*/
|
||||||
|
private function get_token(OAuthRequest &$request, $consumer, $token_type = "access")
|
||||||
|
{
|
||||||
|
$token_field = @$request->get_parameter('oauth_token');
|
||||||
|
$token = $this->data_store->lookup_token(
|
||||||
|
$consumer,
|
||||||
|
$token_type,
|
||||||
|
$token_field
|
||||||
|
);
|
||||||
|
if (!$token) {
|
||||||
|
throw new OAuthException("Invalid $token_type token: $token_field");
|
||||||
|
}
|
||||||
|
return $token;
|
||||||
|
}
|
||||||
|
|
||||||
$this->check_timestamp($timestamp);
|
/**
|
||||||
$this->check_nonce($consumer, $token, $nonce, $timestamp);
|
* all-in-one function to check the signature on a request
|
||||||
|
* should guess the signature method appropriately
|
||||||
|
*
|
||||||
|
* @param OAuthRequest $request
|
||||||
|
* @param OAuthConsumer $consumer
|
||||||
|
* @param OAuthToken|null $token
|
||||||
|
* @throws OAuthException
|
||||||
|
*/
|
||||||
|
private function check_signature(OAuthRequest $request, OAuthConsumer $consumer, OAuthToken $token = null)
|
||||||
|
{
|
||||||
|
// this should probably be in a different method
|
||||||
|
$timestamp = @$request->get_parameter('oauth_timestamp');
|
||||||
|
$nonce = @$request->get_parameter('oauth_nonce');
|
||||||
|
|
||||||
$signature_method = $this->get_signature_method($request);
|
$this->check_timestamp($timestamp);
|
||||||
|
$this->check_nonce($consumer, $token, $nonce, $timestamp);
|
||||||
|
|
||||||
$signature = $request->get_parameter('oauth_signature');
|
$signature_method = $this->get_signature_method($request);
|
||||||
$valid_sig = $signature_method->check_signature(
|
|
||||||
$request,
|
$signature = $request->get_parameter('oauth_signature');
|
||||||
$consumer,
|
$valid_sig = $signature_method->check_signature(
|
||||||
$token,
|
$request,
|
||||||
$signature
|
$consumer,
|
||||||
);
|
$token,
|
||||||
|
$signature
|
||||||
|
);
|
||||||
|
|
||||||
|
|
||||||
if (!$valid_sig) {
|
if (!$valid_sig) {
|
||||||
throw new OAuthException("Invalid signature");
|
throw new OAuthException("Invalid signature");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* check that the timestamp is new enough
|
* check that the timestamp is new enough
|
||||||
*/
|
*
|
||||||
private function check_timestamp($timestamp)
|
* @param int $timestamp
|
||||||
{
|
* @throws OAuthException
|
||||||
if (!$timestamp)
|
*/
|
||||||
throw new OAuthException(
|
private function check_timestamp($timestamp)
|
||||||
'Missing timestamp parameter. The parameter is required'
|
{
|
||||||
);
|
if (!$timestamp)
|
||||||
|
throw new OAuthException(
|
||||||
|
'Missing timestamp parameter. The parameter is required'
|
||||||
|
);
|
||||||
|
|
||||||
// verify that timestamp is recentish
|
// verify that timestamp is recentish
|
||||||
$now = time();
|
$now = time();
|
||||||
if (abs($now - $timestamp) > $this->timestamp_threshold) {
|
if (abs($now - $timestamp) > $this->timestamp_threshold) {
|
||||||
throw new OAuthException(
|
throw new OAuthException(
|
||||||
"Expired timestamp, yours $timestamp, ours $now"
|
"Expired timestamp, yours $timestamp, ours $now"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* check that the nonce is not repeated
|
* check that the nonce is not repeated
|
||||||
*/
|
*
|
||||||
private function check_nonce($consumer, $token, $nonce, $timestamp)
|
* @param OAuthConsumer $consumer
|
||||||
{
|
* @param OAuthToken $token
|
||||||
if (!$nonce)
|
* @param string $nonce
|
||||||
throw new OAuthException(
|
* @param int $timestamp
|
||||||
'Missing nonce parameter. The parameter is required'
|
* @throws OAuthException
|
||||||
);
|
*/
|
||||||
|
private function check_nonce(OAuthConsumer $consumer, OAuthToken $token, $nonce, int $timestamp)
|
||||||
|
{
|
||||||
|
if (!$nonce)
|
||||||
|
throw new OAuthException(
|
||||||
|
'Missing nonce parameter. The parameter is required'
|
||||||
|
);
|
||||||
|
|
||||||
// verify that the nonce is uniqueish
|
// verify that the nonce is uniqueish
|
||||||
$found = $this->data_store->lookup_nonce(
|
$found = $this->data_store->lookup_nonce(
|
||||||
$consumer,
|
$consumer,
|
||||||
$token,
|
$token,
|
||||||
$nonce,
|
$nonce,
|
||||||
$timestamp
|
$timestamp
|
||||||
);
|
);
|
||||||
if ($found) {
|
if ($found) {
|
||||||
throw new OAuthException("Nonce already used: $nonce");
|
throw new OAuthException("Nonce already used: $nonce");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class OAuthDataStore
|
class OAuthDataStore
|
||||||
{
|
{
|
||||||
function lookup_consumer($consumer_key)
|
function lookup_consumer($consumer_key)
|
||||||
{
|
{
|
||||||
// implement me
|
// implement me
|
||||||
}
|
}
|
||||||
|
|
||||||
function lookup_token($consumer, $token_type, $token)
|
function lookup_token(OAuthConsumer $consumer, $token_type, $token_id)
|
||||||
{
|
{
|
||||||
// implement me
|
// implement me
|
||||||
}
|
}
|
||||||
|
|
||||||
function lookup_nonce($consumer, $token, $nonce, $timestamp)
|
function lookup_nonce(OAuthConsumer $consumer, OAuthToken $token, $nonce, int $timestamp)
|
||||||
{
|
{
|
||||||
// implement me
|
// implement me
|
||||||
}
|
}
|
||||||
|
|
||||||
function new_request_token($consumer, $callback = null)
|
function new_request_token(OAuthConsumer $consumer, $callback = null)
|
||||||
{
|
{
|
||||||
// return a new token attached to this consumer
|
// return a new token attached to this consumer
|
||||||
}
|
}
|
||||||
|
|
||||||
function new_access_token($token, $consumer, $verifier = null)
|
function new_access_token(OAuthToken $token, OAuthConsumer $consumer, $verifier = null)
|
||||||
{
|
{
|
||||||
// return a new access token attached to this consumer
|
// return a new access token attached to this consumer
|
||||||
// for the user associated with this token if the request token
|
// for the user associated with this token if the request token
|
||||||
// is authorized
|
// is authorized
|
||||||
// should also invalidate the request token
|
// should also invalidate the request token
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class OAuthUtil
|
class OAuthUtil
|
||||||
{
|
{
|
||||||
public static function urlencode_rfc3986($input)
|
public static function urlencode_rfc3986($input)
|
||||||
{
|
{
|
||||||
if (is_array($input)) {
|
if (is_array($input)) {
|
||||||
return array_map(['OAuthUtil', 'urlencode_rfc3986'], $input);
|
return array_map(['OAuthUtil', 'urlencode_rfc3986'], $input);
|
||||||
} else if (is_scalar($input)) {
|
} else if (is_scalar($input)) {
|
||||||
return str_replace(
|
return str_replace(
|
||||||
'+',
|
'+',
|
||||||
' ',
|
' ',
|
||||||
str_replace('%7E', '~', rawurlencode($input))
|
str_replace('%7E', '~', rawurlencode($input))
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
// This decode function isn't taking into consideration the above
|
// This decode function isn't taking into consideration the above
|
||||||
// modifications to the encoding process. However, this method doesn't
|
// modifications to the encoding process. However, this method doesn't
|
||||||
// seem to be used anywhere so leaving it as is.
|
// seem to be used anywhere so leaving it as is.
|
||||||
public static function urldecode_rfc3986($string)
|
public static function urldecode_rfc3986($string)
|
||||||
{
|
{
|
||||||
return urldecode($string);
|
return urldecode($string);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Utility function for turning the Authorization: header into
|
// Utility function for turning the Authorization: header into
|
||||||
// parameters, has to do some unescaping
|
// parameters, has to do some unescaping
|
||||||
// Can filter out any non-oauth parameters if needed (default behaviour)
|
// Can filter out any non-oauth parameters if needed (default behaviour)
|
||||||
public static function split_header($header, $only_allow_oauth_parameters = true)
|
public static function split_header($header, $only_allow_oauth_parameters = true)
|
||||||
{
|
{
|
||||||
$pattern = '/(([-_a-z]*)=("([^"]*)"|([^,]*)),?)/';
|
$pattern = '/(([-_a-z]*)=("([^"]*)"|([^,]*)),?)/';
|
||||||
$offset = 0;
|
$offset = 0;
|
||||||
$params = [];
|
$params = [];
|
||||||
while (preg_match($pattern, $header, $matches, PREG_OFFSET_CAPTURE, $offset) > 0) {
|
while (preg_match($pattern, $header, $matches, PREG_OFFSET_CAPTURE, $offset) > 0) {
|
||||||
$match = $matches[0];
|
$match = $matches[0];
|
||||||
$header_name = $matches[2][0];
|
$header_name = $matches[2][0];
|
||||||
$header_content = (isset($matches[5])) ? $matches[5][0] : $matches[4][0];
|
$header_content = (isset($matches[5])) ? $matches[5][0] : $matches[4][0];
|
||||||
if (preg_match('/^oauth_/', $header_name) || !$only_allow_oauth_parameters) {
|
if (preg_match('/^oauth_/', $header_name) || !$only_allow_oauth_parameters) {
|
||||||
$params[$header_name] = OAuthUtil::urldecode_rfc3986($header_content);
|
$params[$header_name] = OAuthUtil::urldecode_rfc3986($header_content);
|
||||||
}
|
}
|
||||||
$offset = $match[1] + strlen($match[0]);
|
$offset = $match[1] + strlen($match[0]);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (isset($params['realm'])) {
|
if (isset($params['realm'])) {
|
||||||
unset($params['realm']);
|
unset($params['realm']);
|
||||||
}
|
}
|
||||||
|
|
||||||
return $params;
|
return $params;
|
||||||
}
|
}
|
||||||
|
|
||||||
// helper to try to sort out headers for people who aren't running apache
|
// helper to try to sort out headers for people who aren't running apache
|
||||||
public static function get_headers()
|
public static function get_headers()
|
||||||
{
|
{
|
||||||
if (function_exists('apache_request_headers')) {
|
if (function_exists('apache_request_headers')) {
|
||||||
// we need this to get the actual Authorization: header
|
// we need this to get the actual Authorization: header
|
||||||
// because apache tends to tell us it doesn't exist
|
// because apache tends to tell us it doesn't exist
|
||||||
$headers = apache_request_headers();
|
$headers = apache_request_headers();
|
||||||
|
|
||||||
// sanitize the output of apache_request_headers because
|
// sanitize the output of apache_request_headers because
|
||||||
// we always want the keys to be Cased-Like-This and arh()
|
// we always want the keys to be Cased-Like-This and arh()
|
||||||
// returns the headers in the same case as they are in the
|
// returns the headers in the same case as they are in the
|
||||||
// request
|
// request
|
||||||
$out = [];
|
$out = [];
|
||||||
foreach ($headers as $key => $value) {
|
foreach ($headers as $key => $value) {
|
||||||
$key = str_replace(
|
$key = str_replace(
|
||||||
" ",
|
" ",
|
||||||
"-",
|
"-",
|
||||||
ucwords(strtolower(str_replace("-", " ", $key)))
|
ucwords(strtolower(str_replace("-", " ", $key)))
|
||||||
);
|
);
|
||||||
$out[$key] = $value;
|
$out[$key] = $value;
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
// otherwise we don't have apache and are just going to have to hope
|
// otherwise we don't have apache and are just going to have to hope
|
||||||
// that $_SERVER actually contains what we need
|
// that $_SERVER actually contains what we need
|
||||||
$out = [];
|
$out = [];
|
||||||
if (isset($_SERVER['CONTENT_TYPE']))
|
if (isset($_SERVER['CONTENT_TYPE']))
|
||||||
$out['Content-Type'] = $_SERVER['CONTENT_TYPE'];
|
$out['Content-Type'] = $_SERVER['CONTENT_TYPE'];
|
||||||
if (isset($_ENV['CONTENT_TYPE']))
|
if (isset($_ENV['CONTENT_TYPE']))
|
||||||
$out['Content-Type'] = $_ENV['CONTENT_TYPE'];
|
$out['Content-Type'] = $_ENV['CONTENT_TYPE'];
|
||||||
|
|
||||||
foreach ($_SERVER as $key => $value) {
|
foreach ($_SERVER as $key => $value) {
|
||||||
if (substr($key, 0, 5) == "HTTP_") {
|
if (substr($key, 0, 5) == "HTTP_") {
|
||||||
// this is chaos, basically it is just there to capitalize the first
|
// this is chaos, basically it is just there to capitalize the first
|
||||||
// letter of every word that is not an initial HTTP and strip HTTP
|
// letter of every word that is not an initial HTTP and strip HTTP
|
||||||
// code from przemek
|
// code from przemek
|
||||||
$key = str_replace(
|
$key = str_replace(
|
||||||
" ",
|
" ",
|
||||||
"-",
|
"-",
|
||||||
ucwords(strtolower(str_replace("_", " ", substr($key, 5))))
|
ucwords(strtolower(str_replace("_", " ", substr($key, 5))))
|
||||||
);
|
);
|
||||||
$out[$key] = $value;
|
$out[$key] = $value;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return $out;
|
return $out;
|
||||||
}
|
}
|
||||||
|
|
||||||
// This function takes a input like a=b&a=c&d=e and returns the parsed
|
// This function takes a input like a=b&a=c&d=e and returns the parsed
|
||||||
// parameters like this
|
// parameters like this
|
||||||
// array('a' => array('b','c'), 'd' => 'e')
|
// array('a' => array('b','c'), 'd' => 'e')
|
||||||
public static function parse_parameters($input)
|
public static function parse_parameters($input)
|
||||||
{
|
{
|
||||||
if (!isset($input) || !$input) return array();
|
if (!isset($input) || !$input) return array();
|
||||||
|
|
||||||
$pairs = explode('&', $input);
|
$pairs = explode('&', $input);
|
||||||
|
|
||||||
$parsed_parameters = [];
|
$parsed_parameters = [];
|
||||||
foreach ($pairs as $pair) {
|
foreach ($pairs as $pair) {
|
||||||
$split = explode('=', $pair, 2);
|
$split = explode('=', $pair, 2);
|
||||||
$parameter = OAuthUtil::urldecode_rfc3986($split[0]);
|
$parameter = OAuthUtil::urldecode_rfc3986($split[0]);
|
||||||
$value = isset($split[1]) ? OAuthUtil::urldecode_rfc3986($split[1]) : '';
|
$value = isset($split[1]) ? OAuthUtil::urldecode_rfc3986($split[1]) : '';
|
||||||
|
|
||||||
if (isset($parsed_parameters[$parameter])) {
|
if (isset($parsed_parameters[$parameter])) {
|
||||||
// We have already recieved parameter(s) with this name, so add to the list
|
// We have already recieved parameter(s) with this name, so add to the list
|
||||||
// of parameters with this name
|
// of parameters with this name
|
||||||
|
|
||||||
if (is_scalar($parsed_parameters[$parameter])) {
|
if (is_scalar($parsed_parameters[$parameter])) {
|
||||||
// This is the first duplicate, so transform scalar (string) into an array
|
// This is the first duplicate, so transform scalar (string) into an array
|
||||||
// so we can add the duplicates
|
// so we can add the duplicates
|
||||||
$parsed_parameters[$parameter] = [$parsed_parameters[$parameter]];
|
$parsed_parameters[$parameter] = [$parsed_parameters[$parameter]];
|
||||||
}
|
}
|
||||||
|
|
||||||
$parsed_parameters[$parameter][] = $value;
|
$parsed_parameters[$parameter][] = $value;
|
||||||
} else {
|
} else {
|
||||||
$parsed_parameters[$parameter] = $value;
|
$parsed_parameters[$parameter] = $value;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return $parsed_parameters;
|
return $parsed_parameters;
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function build_http_query($params)
|
public static function build_http_query($params)
|
||||||
{
|
{
|
||||||
if (!$params) return '';
|
if (!$params) return '';
|
||||||
|
|
||||||
// Urlencode both keys and values
|
// Urlencode both keys and values
|
||||||
$keys = OAuthUtil::urlencode_rfc3986(array_keys($params));
|
$keys = OAuthUtil::urlencode_rfc3986(array_keys($params));
|
||||||
$values = OAuthUtil::urlencode_rfc3986(array_values($params));
|
$values = OAuthUtil::urlencode_rfc3986(array_values($params));
|
||||||
$params = array_combine($keys, $values);
|
$params = array_combine($keys, $values);
|
||||||
|
|
||||||
// Parameters are sorted by name, using lexicographical byte value ordering.
|
// Parameters are sorted by name, using lexicographical byte value ordering.
|
||||||
// Ref: Spec: 9.1.1 (1)
|
// Ref: Spec: 9.1.1 (1)
|
||||||
uksort($params, 'strcmp');
|
uksort($params, 'strcmp');
|
||||||
|
|
||||||
$pairs = [];
|
$pairs = [];
|
||||||
foreach ($params as $parameter => $value) {
|
foreach ($params as $parameter => $value) {
|
||||||
if (is_array($value)) {
|
if (is_array($value)) {
|
||||||
// If two or more parameters share the same name, they are sorted by their value
|
// If two or more parameters share the same name, they are sorted by their value
|
||||||
// Ref: Spec: 9.1.1 (1)
|
// Ref: Spec: 9.1.1 (1)
|
||||||
natsort($value);
|
natsort($value);
|
||||||
foreach ($value as $duplicate_value) {
|
foreach ($value as $duplicate_value) {
|
||||||
$pairs[] = $parameter . '=' . $duplicate_value;
|
$pairs[] = $parameter . '=' . $duplicate_value;
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
$pairs[] = $parameter . '=' . $value;
|
$pairs[] = $parameter . '=' . $value;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// For each parameter, the name is separated from the corresponding value by an '=' character (ASCII code 61)
|
// For each parameter, the name is separated from the corresponding value by an '=' character (ASCII code 61)
|
||||||
// Each name-value pair is separated by an '&' character (ASCII code 38)
|
// Each name-value pair is separated by an '&' character (ASCII code 38)
|
||||||
return implode('&', $pairs);
|
return implode('&', $pairs);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -12,6 +12,7 @@ namespace Friendica\Network;
|
||||||
use Friendica\Core\Config;
|
use Friendica\Core\Config;
|
||||||
use Friendica\Core\Logger;
|
use Friendica\Core\Logger;
|
||||||
use Friendica\Database\DBA;
|
use Friendica\Database\DBA;
|
||||||
|
use Friendica\Util\Strings;
|
||||||
use OAuthConsumer;
|
use OAuthConsumer;
|
||||||
use OAuthDataStore;
|
use OAuthDataStore;
|
||||||
use OAuthToken;
|
use OAuthToken;
|
||||||
|
|
@ -26,15 +27,16 @@ class FKOAuthDataStore extends OAuthDataStore
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @return string
|
* @return string
|
||||||
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
private static function genToken()
|
private static function genToken()
|
||||||
{
|
{
|
||||||
return Friendica\Util\Strings::getRandomHex(32);
|
return Strings::getRandomHex(32);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param string $consumer_key key
|
* @param string $consumer_key key
|
||||||
* @return mixed
|
* @return OAuthConsumer|null
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public function lookup_consumer($consumer_key)
|
public function lookup_consumer($consumer_key)
|
||||||
|
|
@ -52,17 +54,17 @@ class FKOAuthDataStore extends OAuthDataStore
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param string $consumer consumer
|
* @param OAuthConsumer $consumer
|
||||||
* @param string $token_type type
|
* @param string $token_type
|
||||||
* @param string $token token
|
* @param string $token_id
|
||||||
* @return mixed
|
* @return OAuthToken|null
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public function lookup_token($consumer, $token_type, $token)
|
public function lookup_token(OAuthConsumer $consumer, $token_type, $token_id)
|
||||||
{
|
{
|
||||||
Logger::log(__function__ . ":" . $consumer . ", " . $token_type . ", " . $token);
|
Logger::log(__function__ . ":" . $consumer . ", " . $token_type . ", " . $token_id);
|
||||||
|
|
||||||
$s = DBA::select('tokens', ['id', 'secret', 'scope', 'expires', 'uid'], ['client_id' => $consumer->key, 'scope' => $token_type, 'id' => $token]);
|
$s = DBA::select('tokens', ['id', 'secret', 'scope', 'expires', 'uid'], ['client_id' => $consumer->key, 'scope' => $token_type, 'id' => $token_id]);
|
||||||
$r = DBA::toArray($s);
|
$r = DBA::toArray($s);
|
||||||
|
|
||||||
if (DBA::isResult($r)) {
|
if (DBA::isResult($r)) {
|
||||||
|
|
@ -77,14 +79,14 @@ class FKOAuthDataStore extends OAuthDataStore
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param string $consumer consumer
|
* @param OAuthConsumer $consumer
|
||||||
* @param string $token token
|
* @param OAuthToken $token
|
||||||
* @param string $nonce nonce
|
* @param string $nonce
|
||||||
* @param string $timestamp timestamp
|
* @param int $timestamp
|
||||||
* @return mixed
|
* @return mixed
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public function lookup_nonce($consumer, $token, $nonce, $timestamp)
|
public function lookup_nonce(OAuthConsumer $consumer, OAuthToken $token, $nonce, int $timestamp)
|
||||||
{
|
{
|
||||||
$token = DBA::selectFirst('tokens', ['id', 'secret'], ['client_id' => $consumer->key, 'id' => $nonce, 'expires' => $timestamp]);
|
$token = DBA::selectFirst('tokens', ['id', 'secret'], ['client_id' => $consumer->key, 'id' => $nonce, 'expires' => $timestamp]);
|
||||||
if (DBA::isResult($token)) {
|
if (DBA::isResult($token)) {
|
||||||
|
|
@ -95,12 +97,12 @@ class FKOAuthDataStore extends OAuthDataStore
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param string $consumer consumer
|
* @param OAuthConsumer $consumer
|
||||||
* @param string $callback optional, default null
|
* @param string $callback
|
||||||
* @return mixed
|
* @return OAuthToken|null
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public function new_request_token($consumer, $callback = null)
|
public function new_request_token(OAuthConsumer $consumer, $callback = null)
|
||||||
{
|
{
|
||||||
Logger::log(__function__ . ":" . $consumer . ", " . $callback);
|
Logger::log(__function__ . ":" . $consumer . ", " . $callback);
|
||||||
$key = self::genToken();
|
$key = self::genToken();
|
||||||
|
|
@ -131,13 +133,13 @@ class FKOAuthDataStore extends OAuthDataStore
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param string $token token
|
* @param OAuthToken $token token
|
||||||
* @param string $consumer consumer
|
* @param OAuthConsumer $consumer consumer
|
||||||
* @param string $verifier optional, defult null
|
* @param string $verifier optional, defult null
|
||||||
* @return object
|
* @return OAuthToken
|
||||||
* @throws HTTPException\InternalServerErrorException
|
* @throws \Exception
|
||||||
*/
|
*/
|
||||||
public function new_access_token($token, $consumer, $verifier = null)
|
public function new_access_token(OAuthToken $token, OAuthConsumer $consumer, $verifier = null)
|
||||||
{
|
{
|
||||||
Logger::log(__function__ . ":" . $token . ", " . $consumer . ", " . $verifier);
|
Logger::log(__function__ . ":" . $token . ", " . $consumer . ", " . $verifier);
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue