(PHP ActiveX) OAuth2 using a SOCKS Proxy (for a Desktop Application)

Demonstrates how to send OAuth2 communications through a SOCKS proxy for a desktop application. The technique is the same for all OAuth2 applications. This one happens to demonstrate for Microsoft Graph.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// To use a SOCKS proxy with OAuth2, create a Chilkat socket object and specify the details for the
// SOCKS proxy server (SOCKS4 or SOCKS5).
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Socket')
$socket = new COM("Chilkat.Socket");
// Use your SOCKS proxy server domain or IP address.
$socket->SocksHostname = 'mysocksproxyserver.com';
// Change this to the listening port of your SOCKS proxy server (if necessary)
$socket->SocksPort = 1080;
$socket->SocksUsername = 'myProxyLogin';
$socket->SocksPassword = 'myProxyPassword';
// Set the SOCKS version to 4 or 5 based on the version
// of the SOCKS proxy server:
$socket->SocksVersion = 5;
// Note: SOCKS4 servers only support usernames without passwords.
// SOCKS5 servers support full login/password authentication.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.OAuth2')
$oauth2 = new COM("Chilkat.OAuth2");

// We don't need to connect the socket beforehand.
// Just tell oauth2 to use the socket which has the SOCKS proxy properties.
$success = $oauth2->UseConnection($socket);

// This should be the port in the localhost callback URL for your app.  
// The callback URL would look like "http://localhost:3017/" if the port number is 3017.
$oauth2->ListenPort = 3017;

$oauth2->AuthorizationEndpoint = 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize';
$oauth2->TokenEndpoint = 'https://login.microsoftonline.com/common/oauth2/v2.0/token';

// Replace these with actual values.
$oauth2->ClientId = 'MICROSOFT-GRAPH-CLIENT-ID';
// This is your app password:
$oauth2->ClientSecret = 'MICROSOFT-GRAPH-CLIENT-SECRET';

$oauth2->CodeChallenge = 0;
// Provide a SPACE separated list of scopes.
// See https://developer.microsoft.com/en-us/graph/docs/authorization/permission_scopes 

// Important: To get a refresh token in the final response, you have to ask for "offline_access" scope
$oauth2->Scope = 'openid profile offline_access user.readwrite mail.readwrite mail.send files.readwrite';

// Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
$url = $oauth2->startAuth();
if ($oauth2->LastMethodSuccess != 1) {
    print $oauth2->LastErrorText . "\n";
    exit;
}

// At this point, your application should load the URL in a browser.
// For example, 
// in C#: System.Diagnostics.Process.Start(url);
// in Java: Desktop.getDesktop().browse(new URI(url));
// in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
//              wsh.Run url
// in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
// in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl        
// The Microsoft account owner would interactively accept or deny the authorization request.

// Add the code to load the url in a web browser here...
// Add the code to load the url in a web browser here...
// Add the code to load the url in a web browser here...

// Now wait for the authorization.
// We'll wait for a max of 30 seconds.
$numMsWaited = 0;
while (($numMsWaited < 30000) and ($oauth2->AuthFlowState < 3)) {
    $oauth2->SleepMs(100);
    $numMsWaited = $numMsWaited + 100;
}

// If there was no response from the browser within 30 seconds, then 
// the AuthFlowState will be equal to 1 or 2.
// 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
// 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
// In that case, cancel the background task started in the call to StartAuth.
if ($oauth2->AuthFlowState < 3) {
    $oauth2->Cancel();
    print 'No response from the browser!' . "\n";
    exit;
}

// Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
// The possible AuthFlowState values are:
// 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
// 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
// 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
if ($oauth2->AuthFlowState == 5) {
    print 'OAuth2 failed to complete.' . "\n";
    print $oauth2->FailureInfo . "\n";
    exit;
}

if ($oauth2->AuthFlowState == 4) {
    print 'OAuth2 authorization was denied.' . "\n";
    print $oauth2->AccessTokenResponse . "\n";
    exit;
}

if ($oauth2->AuthFlowState != 3) {
    print 'Unexpected AuthFlowState:' . $oauth2->AuthFlowState . "\n";
    exit;
}

print 'OAuth2 authorization granted!' . "\n";
print 'Access Token = ' . $oauth2->AccessToken . "\n";

// Get the full JSON response:
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->Load($oauth2->AccessTokenResponse);
$json->EmitCompact = 0;

// The JSON response looks like this:

// {
//   "token_type": "Bearer",
//   "scope": "User.Read Mail.ReadWrite Mail.Send",
//   "expires_in": 3600,
//   "ext_expires_in": 0,
//   "access_token": "EwBAA8l6B...",
//   "refresh_token": "MCRMdbe...",
//   "id_token": "eyJ0eXA..."
// }

// If an "expires_on" member does not exist, then add the JSON member by
// getting the current system date/time and adding the "expires_in" seconds.
// This way we'll know when the token expires.
if ($json->HasMember('expires_on') != 1) {
    // For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.CkDateTime')
    $dtExpire = new COM("Chilkat.CkDateTime");
    $dtExpire->SetFromCurrentSystemTime();
    $dtExpire->AddSeconds($json->IntOf('expires_in'));
    $json->AppendString('expires_on',$dtExpire->getAsUnixTimeStr(0));
}

print $json->emit() . "\n";

// Save the JSON to a file for future requests.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.FileAccess')
$fac = new COM("Chilkat.FileAccess");
$fac->WriteEntireTextFile('qa_data/tokens/microsoftGraph.json',$json->emit(),'utf-8',0);

?>