/* Generic exception class
*/
if (!class_exists('OAuthException', false)) {
- class OAuthException extends Exception {
- // pass
- }
+ class OAuthException extends Exception
+ { }
}
-class OAuthConsumer {
+class OAuthConsumer
+{
public $key;
public $secret;
- function __construct($key, $secret, $callback_url=NULL) {
+ function __construct($key, $secret, $callback_url = NULL)
+ {
$this->key = $key;
$this->secret = $secret;
$this->callback_url = $callback_url;
}
- function __toString() {
+ function __toString()
+ {
return "OAuthConsumer[key=$this->key,secret=$this->secret]";
}
}
-class OAuthToken {
+class OAuthToken
+{
// access tokens and request tokens
public $key;
public $secret;
* key = the token
* secret = the token secret
*/
- function __construct($key, $secret) {
+ function __construct($key, $secret)
+ {
$this->key = $key;
$this->secret = $secret;
}
* generates the basic string serialization of a token that a server
* would respond to request_token and access_token calls with
*/
- function to_string() {
+ function to_string()
+ {
return "oauth_token=" .
- OAuthUtil::urlencode_rfc3986($this->key) .
- "&oauth_token_secret=" .
- OAuthUtil::urlencode_rfc3986($this->secret);
+ OAuthUtil::urlencode_rfc3986($this->key) .
+ "&oauth_token_secret=" .
+ OAuthUtil::urlencode_rfc3986($this->secret);
}
- function __toString() {
+ function __toString()
+ {
return $this->to_string();
}
}
* A class for implementing a Signature Method
* See section 9 ("Signing Requests") in the spec
*/
-abstract class OAuthSignatureMethod {
+abstract class OAuthSignatureMethod
+{
/**
* Needs to return the name of the Signature Method (ie HMAC-SHA1)
* @return string
* @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);
}
}
/**
- * The HMAC-SHA1 signature method uses the HMAC-SHA1 signature algorithm as defined in [RFC2104]
- * where the Signature Base String is the text and the key is the concatenated values (each first
- * encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&'
+ * The HMAC-SHA1 signature method uses the HMAC-SHA1 signature algorithm as defined in [RFC2104]
+ * where the Signature Base String is the text and the key is the concatenated values (each first
+ * encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&'
* character (ASCII code 38) even if empty.
* - Chapter 9.2 ("HMAC-SHA1")
*/
-class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod {
- function get_name() {
+class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod
+{
+ function get_name()
+ {
return "HMAC-SHA1";
}
- public function build_signature($request, $consumer, $token) {
+ public function build_signature($request, $consumer, $token)
+ {
$base_string = $request->get_signature_base_string();
$request->base_string = $base_string;
}
/**
- * The PLAINTEXT method does not provide any security protection and SHOULD only be used
+ * The PLAINTEXT method does not provide any security protection and SHOULD only be used
* over a secure channel such as HTTPS. It does not use the Signature Base String.
* - Chapter 9.4 ("PLAINTEXT")
*/
-class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod {
- public function get_name() {
+class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod
+{
+ public function get_name()
+ {
return "PLAINTEXT";
}
/**
- * 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
+ * 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
* empty. The result MUST be encoded again.
* - Chapter 9.4.1 ("Generating Signatures")
*
* Please note that the second encoding MUST NOT happen in the SignatureMethod, as
* OAuthRequest handles this!
*/
- public function build_signature($request, $consumer, $token) {
+ public function build_signature($request, $consumer, $token)
+ {
$key_parts = array(
$consumer->secret,
($token) ? $token->secret : ""
}
/**
- * The RSA-SHA1 signature method uses the RSASSA-PKCS1-v1_5 signature algorithm as defined in
- * [RFC3447] section 8.2 (more simply known as PKCS#1), using SHA-1 as the hash function for
- * EMSA-PKCS1-v1_5. It is assumed that the Consumer has provided its RSA public key in a
- * verified way to the Service Provider, in a manner which is beyond the scope of this
+ * The RSA-SHA1 signature method uses the RSASSA-PKCS1-v1_5 signature algorithm as defined in
+ * [RFC3447] section 8.2 (more simply known as PKCS#1), using SHA-1 as the hash function for
+ * EMSA-PKCS1-v1_5. It is assumed that the Consumer has provided its RSA public key in a
+ * verified way to the Service Provider, in a manner which is beyond the scope of this
* specification.
* - Chapter 9.3 ("RSA-SHA1")
*/
-abstract class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod {
- public function get_name() {
+abstract class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod
+{
+ public function get_name()
+ {
return "RSA-SHA1";
}
// Either way should return a string representation of the certificate
protected abstract function fetch_private_cert(&$request);
- public function build_signature($request, $consumer, $token) {
+ public function build_signature($request, $consumer, $token)
+ {
$base_string = $request->get_signature_base_string();
$request->base_string = $base_string;
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);
$base_string = $request->get_signature_base_string();
}
}
-class OAuthRequest {
+class OAuthRequest
+{
private $parameters;
private $http_method;
private $http_url;
public static $version = '1.0';
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 = 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->http_method = $http_method;
$this->http_url = $http_url;
/**
* 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) {
+ public static function from_request($http_method = NULL, $http_url = NULL, $parameters = NULL)
+ {
$scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on")
- ? 'http'
- : 'https';
+ ? 'http'
+ : 'https';
@$http_url or $http_url = $scheme .
- '://' . $_SERVER['HTTP_HOST'] .
- ':' .
- $_SERVER['SERVER_PORT'] .
- $_SERVER['REQUEST_URI'];
+ '://' . $_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
// It's a POST request of the proper content-type, so parse POST
// parameters and add those overriding any duplicates from GET
- if ($http_method == "POST"
- && @strstr($request_headers["Content-Type"],
- "application/x-www-form-urlencoded")
- ) {
+ if (
+ $http_method == "POST"
+ && @strstr(
+ $request_headers["Content-Type"],
+ "application/x-www-form-urlencoded"
+ )
+ ) {
$post_data = OAuthUtil::parse_parameters(
file_get_contents(self::$POST_INPUT)
);
);
$parameters = array_merge($parameters, $header_parameters);
}
-
}
// fix for friendica redirect system
-
- $http_url = substr($http_url, 0, strpos($http_url,$parameters['pagename'])+strlen($parameters['pagename']));
- unset( $parameters['pagename'] );
-
+
+ $http_url = substr($http_url, 0, strpos($http_url, $parameters['pagename']) + strlen($parameters['pagename']));
+ unset($parameters['pagename']);
+
return new OAuthRequest($http_method, $http_url, $parameters);
}
/**
* 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) {
+ public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters = NULL)
+ {
@$parameters or $parameters = array();
- $defaults = array("oauth_version" => OAuthRequest::$version,
- "oauth_nonce" => OAuthRequest::generate_nonce(),
- "oauth_timestamp" => OAuthRequest::generate_timestamp(),
- "oauth_consumer_key" => $consumer->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;
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])) {
// We have already added parameter(s) with this name, so add to the list
if (is_scalar($this->parameters[$name])) {
}
}
- public function get_parameter($name) {
+ public function get_parameter($name)
+ {
return isset($this->parameters[$name]) ? $this->parameters[$name] : null;
}
- public function get_parameters() {
+ public function get_parameters()
+ {
return $this->parameters;
}
- public function unset_parameter($name) {
+ public function unset_parameter($name)
+ {
unset($this->parameters[$name]);
}
* The request parameters, sorted and concatenated into a normalized string.
* @return string
*/
- public function get_signable_parameters() {
+ public function get_signable_parameters()
+ {
// Grab all parameters
$params = $this->parameters;
* and the parameters (normalized), each urlencoded
* and the concated with &.
*/
- public function get_signature_base_string() {
+ public function get_signature_base_string()
+ {
$parts = array(
$this->get_normalized_http_method(),
$this->get_normalized_http_url(),
/**
* just uppercases the http method
*/
- public function get_normalized_http_method() {
+ public function get_normalized_http_method()
+ {
return strtoupper($this->http_method);
}
* parses the url and rebuilds it to be
* scheme://host/path
*/
- public function get_normalized_http_url() {
+ public function get_normalized_http_url()
+ {
$parts = parse_url($this->http_url);
$port = @$parts['port'];
$port or $port = ($scheme == 'https') ? '443' : '80';
if (($scheme == 'https' && $port != '443')
- || ($scheme == 'http' && $port != '80')) {
+ || ($scheme == 'http' && $port != '80')
+ ) {
$host = "$host:$port";
}
return "$scheme://$host$path";
/**
* builds a url usable for a GET request
*/
- public function to_url() {
+ public function to_url()
+ {
$post_data = $this->to_postdata();
$out = $this->get_normalized_http_url();
if ($post_data) {
- $out .= '?'.$post_data;
+ $out .= '?' . $post_data;
}
return $out;
}
/**
* builds the data one would send in a POST request
*/
- public function to_postdata($raw = false) {
+ public function to_postdata($raw = false)
+ {
if ($raw)
- return($this->parameters);
+ return $this->parameters;
else
return OAuthUtil::build_http_query($this->parameters);
}
/**
* builds the Authorization: header
*/
- public function to_header($realm=null) {
+ public function to_header($realm = null)
+ {
$first = true;
- if($realm) {
+ if ($realm) {
$out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"';
$first = false;
} else
$out = 'Authorization: OAuth';
- $total = array();
foreach ($this->parameters as $k => $v) {
if (substr($k, 0, 5) != "oauth") continue;
if (is_array($v)) {
}
$out .= ($first) ? ' ' : ',';
$out .= OAuthUtil::urlencode_rfc3986($k) .
- '="' .
- OAuthUtil::urlencode_rfc3986($v) .
- '"';
+ '="' .
+ OAuthUtil::urlencode_rfc3986($v) .
+ '"';
$first = false;
}
return $out;
}
- public function __toString() {
+ public function __toString()
+ {
return $this->to_url();
}
- public function sign_request($signature_method, $consumer, $token) {
+ public function sign_request($signature_method, $consumer, $token)
+ {
$this->set_parameter(
"oauth_signature_method",
$signature_method->get_name(),
$this->set_parameter("oauth_signature", $signature, false);
}
- public function build_signature($signature_method, $consumer, $token) {
+ public function build_signature($signature_method, $consumer, $token)
+ {
$signature = $signature_method->build_signature($this, $consumer, $token);
return $signature;
}
/**
* util function: current timestamp
*/
- private static function generate_timestamp() {
+ private static function generate_timestamp()
+ {
return time();
}
/**
* util function: current nonce
*/
- private static function generate_nonce() {
- $mt = microtime();
- $rand = mt_rand();
-
- return md5($mt . $rand); // md5s look nicer than numbers
+ private static function generate_nonce()
+ {
+ return bin2hex(random_bytes(16));
}
}
-class OAuthServer {
+class OAuthServer
+{
protected $timestamp_threshold = 300; // in seconds, five minutes
protected $version = '1.0'; // hi blaine
protected $signature_methods = array();
protected $data_store;
- function __construct($data_store) {
+ function __construct($data_store)
+ {
$this->data_store = $data_store;
}
- public function add_signature_method($signature_method) {
+ public function add_signature_method($signature_method)
+ {
$this->signature_methods[$signature_method->get_name()] =
$signature_method;
}
* process a request_token request
* returns the request token on success
*/
- public function fetch_request_token(&$request) {
+ public function fetch_request_token(&$request)
+ {
$this->get_version($request);
$consumer = $this->get_consumer($request);
* process an access_token request
* returns the access token on success
*/
- public function fetch_access_token(&$request) {
+ public function fetch_access_token(&$request)
+ {
$this->get_version($request);
$consumer = $this->get_consumer($request);
/**
* verify an api call, checks all the parameters
*/
- public function verify_request(&$request) {
+ public function verify_request(&$request)
+ {
$this->get_version($request);
$consumer = $this->get_consumer($request);
$token = $this->get_token($request, $consumer, "access");
$this->check_signature($request, $consumer, $token);
- return array($consumer, $token);
+ return [$consumer, $token];
}
// Internals from here
/**
* version 1
*/
- private function get_version(&$request) {
+ 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.
+ // 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';
}
/**
* figure out the signature with some defaults
*/
- private function get_signature_method(&$request) {
+ private function get_signature_method(&$request)
+ {
$signature_method =
- @$request->get_parameter("oauth_signature_method");
+ @$request->get_parameter("oauth_signature_method");
if (!$signature_method) {
// According to chapter 7 ("Accessing Protected Ressources") the signature-method
throw new OAuthException('No signature method parameter. This parameter is required');
}
- if (!in_array($signature_method,
- array_keys($this->signature_methods))) {
+ if (!in_array(
+ $signature_method,
+ array_keys($this->signature_methods)
+ )) {
throw new OAuthException(
"Signature method '$signature_method' not supported " .
- "try one of the following: " .
- implode(", ", array_keys($this->signature_methods))
+ "try one of the following: " .
+ implode(", ", array_keys($this->signature_methods))
);
}
return $this->signature_methods[$signature_method];
/**
* try to find the consumer for the provided request's consumer key
*/
- private function get_consumer(&$request) {
+ private function get_consumer(&$request)
+ {
$consumer_key = @$request->get_parameter("oauth_consumer_key");
if (!$consumer_key) {
throw new OAuthException("Invalid consumer key");
/**
* try to find the token for the provided request's token key
*/
- private function get_token(&$request, $consumer, $token_type="access") {
+ 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
+ $consumer,
+ $token_type,
+ $token_field
);
if (!$token) {
throw new OAuthException("Invalid $token_type token: $token_field");
* all-in-one function to check the signature on a request
* should guess the signature method appropriately
*/
- private function check_signature(&$request, $consumer, $token) {
+ private function check_signature(&$request, $consumer, $token)
+ {
// this should probably be in a different method
$timestamp = @$request->get_parameter('oauth_timestamp');
$nonce = @$request->get_parameter('oauth_nonce');
$token,
$signature
);
-
+
if (!$valid_sig) {
throw new OAuthException("Invalid signature");
/**
* check that the timestamp is new enough
*/
- private function check_timestamp($timestamp) {
- if( ! $timestamp )
+ private function check_timestamp($timestamp)
+ {
+ if (!$timestamp)
throw new OAuthException(
'Missing timestamp parameter. The parameter is required'
);
-
+
// verify that timestamp is recentish
$now = time();
if (abs($now - $timestamp) > $this->timestamp_threshold) {
/**
* check that the nonce is not repeated
*/
- private function check_nonce($consumer, $token, $nonce, $timestamp) {
- if( ! $nonce )
+ private function check_nonce($consumer, $token, $nonce, $timestamp)
+ {
+ if (!$nonce)
throw new OAuthException(
'Missing nonce parameter. The parameter is required'
);
throw new OAuthException("Nonce already used: $nonce");
}
}
-
}
-class OAuthDataStore {
- function lookup_consumer($consumer_key) {
+class OAuthDataStore
+{
+ function lookup_consumer($consumer_key)
+ {
// implement me
}
- function lookup_token($consumer, $token_type, $token) {
+ function lookup_token($consumer, $token_type, $token)
+ {
// implement me
}
- function lookup_nonce($consumer, $token, $nonce, $timestamp) {
+ function lookup_nonce($consumer, $token, $nonce, $timestamp)
+ {
// implement me
}
- function new_request_token($consumer, $callback = null) {
+ function new_request_token($consumer, $callback = null)
+ {
// return a new token attached to this consumer
}
- function new_access_token($token, $consumer, $verifier = null) {
+ function new_access_token($token, $consumer, $verifier = null)
+ {
// return a new access token attached to this consumer
// for the user associated with this token if the request token
// is authorized
// should also invalidate the request token
}
-
}
-class OAuthUtil {
- public static function urlencode_rfc3986($input) {
- if (is_array($input)) {
- return array_map(array('OAuthUtil', 'urlencode_rfc3986'), $input);
- } else if (is_scalar($input)) {
- return str_replace(
- '+',
- ' ',
- str_replace('%7E', '~', rawurlencode($input))
- );
- } else {
- return '';
+class OAuthUtil
+{
+ public static function urlencode_rfc3986($input)
+ {
+ if (is_array($input)) {
+ return array_map(['OAuthUtil', 'urlencode_rfc3986'], $input);
+ } else if (is_scalar($input)) {
+ return str_replace(
+ '+',
+ ' ',
+ str_replace('%7E', '~', rawurlencode($input))
+ );
+ } else {
+ return '';
+ }
}
-}
// This decode function isn't taking into consideration the above
// modifications to the encoding process. However, this method doesn't
// 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);
}
// Utility function for turning the Authorization: header into
// parameters, has to do some unescaping
// 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]*)=("([^"]*)"|([^,]*)),?)/';
$offset = 0;
- $params = array();
+ $params = [];
while (preg_match($pattern, $header, $matches, PREG_OFFSET_CAPTURE, $offset) > 0) {
$match = $matches[0];
$header_name = $matches[2][0];
}
// 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')) {
// we need this to get the actual Authorization: header
// because apache tends to tell us it doesn't exist
// we always want the keys to be Cased-Like-This and arh()
// returns the headers in the same case as they are in the
// request
- $out = array();
- foreach( $headers AS $key => $value ) {
+ $out = [];
+ foreach ($headers as $key => $value) {
$key = str_replace(
- " ",
- "-",
- ucwords(strtolower(str_replace("-", " ", $key)))
- );
+ " ",
+ "-",
+ ucwords(strtolower(str_replace("-", " ", $key)))
+ );
$out[$key] = $value;
}
} else {
// otherwise we don't have apache and are just going to have to hope
// that $_SERVER actually contains what we need
- $out = array();
- if( isset($_SERVER['CONTENT_TYPE']) )
+ $out = [];
+ if (isset($_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'];
foreach ($_SERVER as $key => $value) {
// This function takes a input like a=b&a=c&d=e and returns the parsed
// parameters like this
// 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();
$pairs = explode('&', $input);
- $parsed_parameters = array();
+ $parsed_parameters = [];
foreach ($pairs as $pair) {
$split = explode('=', $pair, 2);
$parameter = OAuthUtil::urldecode_rfc3986($split[0]);
if (is_scalar($parsed_parameters[$parameter])) {
// This is the first duplicate, so transform scalar (string) into an array
// so we can add the duplicates
- $parsed_parameters[$parameter] = array($parsed_parameters[$parameter]);
+ $parsed_parameters[$parameter] = [$parsed_parameters[$parameter]];
}
$parsed_parameters[$parameter][] = $value;
return $parsed_parameters;
}
- public static function build_http_query($params) {
+ public static function build_http_query($params)
+ {
if (!$params) return '';
// Urlencode both keys and values
// Ref: Spec: 9.1.1 (1)
uksort($params, 'strcmp');
- $pairs = array();
+ $pairs = [];
foreach ($params as $parameter => $value) {
if (is_array($value)) {
// If two or more parameters share the same name, they are sorted by their value
return implode('&', $pairs);
}
}
-
-?>
projects / friendica.git / blobdiff