(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# 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).
socket = Chilkat::CkSocket.new()
# Use your SOCKS proxy server domain or IP address.
socket.put_SocksHostname("mysocksproxyserver.com")
# Change this to the listening port of your SOCKS proxy server (if necessary)
socket.put_SocksPort(1080)
socket.put_SocksUsername("myProxyLogin")
socket.put_SocksPassword("myProxyPassword")
# Set the SOCKS version to 4 or 5 based on the version
# of the SOCKS proxy server:
socket.put_SocksVersion(5)
# Note: SOCKS4 servers only support usernames without passwords.
# SOCKS5 servers support full login/password authentication.

oauth2 = Chilkat::CkOAuth2.new()

# 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.put_ListenPort(3017)

oauth2.put_AuthorizationEndpoint("https://login.microsoftonline.com/common/oauth2/v2.0/authorize")
oauth2.put_TokenEndpoint("https://login.microsoftonline.com/common/oauth2/v2.0/token")

# Replace these with actual values.
oauth2.put_ClientId("MICROSOFT-GRAPH-CLIENT-ID")
# This is your app password:
oauth2.put_ClientSecret("MICROSOFT-GRAPH-CLIENT-SECRET")

oauth2.put_CodeChallenge(false)
# 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.put_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.get_LastMethodSuccess() != true)
    print oauth2.lastErrorText() + "\n";
    exit
end

# 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.get_AuthFlowState() < 3)
    oauth2.SleepMs(100)
    numMsWaited = numMsWaited + 100
end

# 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.get_AuthFlowState() < 3)
    oauth2.Cancel()
    print "No response from the browser!" + "\n";
    exit
end

# 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.get_AuthFlowState() == 5)
    print "OAuth2 failed to complete." + "\n";
    print oauth2.failureInfo() + "\n";
    exit
end

if (oauth2.get_AuthFlowState() == 4)
    print "OAuth2 authorization was denied." + "\n";
    print oauth2.accessTokenResponse() + "\n";
    exit
end

if (oauth2.get_AuthFlowState() != 3)
    print "Unexpected AuthFlowState:" + oauth2.get_AuthFlowState().to_s() + "\n";
    exit
end

print "OAuth2 authorization granted!" + "\n";
print "Access Token = " + oauth2.accessToken() + "\n";

# Get the full JSON response:
json = Chilkat::CkJsonObject.new()
json.Load(oauth2.accessTokenResponse())
json.put_EmitCompact(false)

# 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") != true)
    dtExpire = Chilkat::CkDateTime.new()
    dtExpire.SetFromCurrentSystemTime()
    dtExpire.AddSeconds(json.IntOf("expires_in"))
    json.AppendString("expires_on",dtExpire.getAsUnixTimeStr(false))
end

print json.emit() + "\n";

# Save the JSON to a file for future requests.
fac = Chilkat::CkFileAccess.new()
fac.WriteEntireTextFile("qa_data/tokens/microsoftGraph.json",json.emit(),"utf-8",false)