Last active
May 14, 2020 09:33
-
-
Save Carlo-F/dfe15fe2de59711f6658600022d88b2c to your computer and use it in GitHub Desktop.
Simple PHP example of using Github's OAuth 2 API
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
define('OAUTH2_CLIENT_ID', ''); | |
define('OAUTH2_CLIENT_SECRET', ''); | |
// see https://developer.github.com/v3/#user-agent-required | |
define('APP_NAME','GH WHATEVER'); | |
$authorizeURL = 'https://github.com/login/oauth/authorize'; | |
$tokenURL = 'https://github.com/login/oauth/access_token'; | |
$apiURLBase = 'https://api.github.com'; | |
// or, in the case of https://education.github.com/pack, uncomment this: | |
//$apiURLBase = 'https://education.github.com/api'; | |
session_start(); | |
// Start the login process by sending the user to Github's authorization page | |
if(get('action') == 'login') { | |
// Generate a random hash and store in the session for security | |
$_SESSION['state'] = hash('sha256', microtime(TRUE).rand().$_SERVER['REMOTE_ADDR']); | |
unset($_SESSION['access_token']); | |
$params = array( | |
'client_id' => OAUTH2_CLIENT_ID, | |
'redirect_uri' => $_SERVER['SERVER_PROTOCOL'].'://' . $_SERVER['SERVER_NAME'] . $_SERVER['PHP_SELF'], | |
'scope' => 'user', | |
'state' => $_SESSION['state'] | |
); | |
// Redirect the user to Github's authorization page | |
header('Location: ' . $authorizeURL . '?' . http_build_query($params)); | |
die(); | |
} | |
// When Github redirects the user back here, there will be a "code" and "state" parameter in the query string | |
if(get('code')) { | |
// Verify the state matches our stored state | |
if(!get('state') || $_SESSION['state'] != get('state')) { | |
header('Location: ' . $_SERVER['PHP_SELF']); | |
die(); | |
} | |
// Exchange the auth code for a token | |
$token = apiRequest($tokenURL, array( | |
'client_id' => OAUTH2_CLIENT_ID, | |
'client_secret' => OAUTH2_CLIENT_SECRET, | |
'redirect_uri' => $_SERVER['SERVER_PROTOCOL']. '://' . $_SERVER['SERVER_NAME'] . $_SERVER['PHP_SELF'], | |
'state' => $_SESSION['state'], | |
'User-Agent' => APP_NAME, | |
'code' => get('code') | |
)); | |
$_SESSION['access_token'] = $token->access_token; | |
header('Location: ' . $_SERVER['PHP_SELF']); | |
} | |
if(session('access_token')) { | |
$response = apiRequest($apiURLBase. '/user'); | |
echo '<h3>Logged In</h3>'; | |
echo '<pre>'; | |
print_r($response); | |
echo '</pre>'; | |
} else { | |
echo '<h3>Not logged in</h3>'; | |
echo '<p><a href="?action=login">Log In</a></p>'; | |
} | |
function apiRequest($url, $post=FALSE, $headers=array()) | |
{ | |
$ch = curl_init($url); | |
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE); | |
if($post) | |
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post)); | |
$headers[] = 'Accept: application/json'; | |
if(session('access_token')) | |
$headers[] = 'Authorization: Bearer ' . session('access_token'); | |
$headers[] = 'User-Agent:' . APP_NAME; | |
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); | |
$response = curl_exec($ch); | |
return json_decode($response); | |
} | |
function get($key, $default=NULL) | |
{ | |
return array_key_exists($key, $_GET) ? $_GET[$key] : $default; | |
} | |
function session($key, $default=NULL) | |
{ | |
return array_key_exists($key, $_SESSION) ? $_SESSION[$key] : $default; | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment