Xbase++ Requires Chilkat v10.1.2+
Xbase++
OAuth2 using an HTTP Proxy (for a Desktop Application)
See more OAuth2 Examples
Shows how to send OAuth2 communications through an HTTP proxy in a desktop application, using Microsoft Graph as an example. This method applies to all OAuth2 applications.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oSocket
LOCAL oOauth2
LOCAL cUrl
LOCAL nNumMsWaited
LOCAL oJson
LOCAL oDtExpire
LOCAL oFac
nSuccess := 0
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// To use an HTTP proxy with OAuth2, create a Chilkat socket object and specify the details.
oSocket := CreateObject("Chilkat.Socket")
// Use your HTTP proxy server domain or IP address.
oSocket:HttpProxyHostname := "myproxyserver.com"
// Change this to the listening port of your HTTP proxy server (if necessary)
oSocket:HttpProxyPort := 808
// Specify login/password if needed.
oSocket:HttpProxyUsername := "myProxyLogin"
oSocket:HttpProxyPassword := "myProxyPassword"
oSocket:HttpProxyForHttp := 1
oOauth2 := CreateObject("Chilkat.OAuth2")
// We don't need to connect the socket beforehand.
// Just tell oauth2 to use the socket which has the HTTP proxy properties.
nSuccess := oOauth2:UseConnection(oSocket)
// 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.
oOauth2:ListenPort := 3017
oOauth2:AuthorizationEndpoint := "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"
oOauth2:TokenEndpoint := "https://login.microsoftonline.com/common/oauth2/v2.0/token"
// Replace these with actual values.
oOauth2:ClientId := "MICROSOFT-GRAPH-CLIENT-ID"
// This is your app password:
oOauth2:ClientSecret := "MICROSOFT-GRAPH-CLIENT-SECRET"
oOauth2: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
oOauth2:Scope := "openid profile offline_access user.readwrite mail.readwrite mail.send files.readwrite"
// Begin the OAuth2 Authorization code flow. This returns a URL that should be loaded in a browser.
cUrl := oOauth2:StartAuth()
IF (oOauth2:LastMethodSuccess != 1)
? oOauth2:LastErrorText
oSocket:destroy()
oOauth2:destroy()
RETURN
ENDIF
? "url = " + cUrl
// Launch the default browser on the system and navigate to the url.
// The LaunchBrowser method was added in Chilkat v10.1.2.
nSuccess := oOauth2:LaunchBrowser(cUrl)
IF (nSuccess == 0)
? oOauth2:LastErrorText
oSocket:destroy()
oOauth2:destroy()
RETURN
ENDIF
// Wait for the user to approve or deny authorization in the browser.
nNumMsWaited := 0
DO WHILE (nNumMsWaited < 90000) .AND. (oOauth2:AuthFlowState < 3)
oOauth2:SleepMs(100)
nNumMsWaited := nNumMsWaited + 100
ENDDO
// If the browser does not respond within the specified time, AuthFlowState will be:
//
// 1: Waiting for Redirect - The OAuth2 background thread is waiting for the browser's redirect request.
// 2: Waiting for Final Response - The thread is awaiting the final access token response.
// In either case, cancel the background task initiated by StartAuth.
IF (oOauth2:AuthFlowState < 3)
oOauth2:Cancel()
? "No response from the browser!"
oSocket:destroy()
oOauth2:destroy()
RETURN
ENDIF
// Check AuthFlowState to determine if authorization was granted, denied, or failed:
//
// 3: Success - OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
// 4: Access Denied - OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
// 5: Failure - OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.
IF (oOauth2:AuthFlowState == 5)
? "OAuth2 failed to complete."
? oOauth2:FailureInfo
oSocket:destroy()
oOauth2:destroy()
RETURN
ENDIF
IF (oOauth2:AuthFlowState == 4)
? "OAuth2 authorization was denied."
? oOauth2:AccessTokenResponse
oSocket:destroy()
oOauth2:destroy()
RETURN
ENDIF
IF (oOauth2:AuthFlowState != 3)
? "Unexpected AuthFlowState:" + Str(oOauth2:AuthFlowState)
oSocket:destroy()
oOauth2:destroy()
RETURN
ENDIF
? "OAuth2 authorization granted!"
? "Access Token = " + oOauth2:AccessToken
// Get the full JSON response:
oJson := CreateObject("Chilkat.JsonObject")
oJson:Load(oOauth2:AccessTokenResponse)
oJson: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 (oJson:HasMember("expires_on") != 1)
oDtExpire := CreateObject("Chilkat.CkDateTime")
oDtExpire:SetFromCurrentSystemTime()
oDtExpire:AddSeconds(oJson:IntOf("expires_in"))
oJson:AppendString("expires_on", oDtExpire:GetAsUnixTimeStr(0))
ENDIF
? oJson:Emit()
// Save the JSON to a file for future requests.
oFac := CreateObject("Chilkat.FileAccess")
oFac:WriteEntireTextFile("qa_data/tokens/microsoftGraph.json", oJson:Emit(), "utf-8", 0)
oSocket:destroy()
oOauth2:destroy()
oJson:destroy()
oDtExpire:destroy()
oFac:destroy()