(PureBasic) OAuth2 using an HTTP Proxy (for a Desktop Application)

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkSocket.pb"
IncludeFile "CkFileAccess.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkOAuth2.pb"
IncludeFile "CkDateTime.pb"

Procedure ChilkatExample()

    ; 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.
    socket.i = CkSocket::ckCreate()
    If socket.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Use your HTTP proxy server domain or IP address.
    CkSocket::setCkHttpProxyHostname(socket, "myproxyserver.com")
    ; Change this to the listening port of your HTTP proxy server (if necessary)
    CkSocket::setCkHttpProxyPort(socket, 808)
    ; Specify login/password if needed.
    CkSocket::setCkHttpProxyUsername(socket, "myProxyLogin")
    CkSocket::setCkHttpProxyPassword(socket, "myProxyPassword")
    CkSocket::setCkHttpProxyForHttp(socket, 1)

    oauth2.i = CkOAuth2::ckCreate()
    If oauth2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; We don't need to connect the socket beforehand.
    ; Just tell oauth2 to use the socket which has the HTTP proxy properties.
    success = CkOAuth2::ckUseConnection(oauth2,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.
    CkOAuth2::setCkListenPort(oauth2, 3017)

    CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://login.microsoftonline.com/common/oauth2/v2.0/authorize")
    CkOAuth2::setCkTokenEndpoint(oauth2, "https://login.microsoftonline.com/common/oauth2/v2.0/token")

    ; Replace these with actual values.
    CkOAuth2::setCkClientId(oauth2, "MICROSOFT-GRAPH-CLIENT-ID")
    ; This is your app password:
    CkOAuth2::setCkClientSecret(oauth2, "MICROSOFT-GRAPH-CLIENT-SECRET")

    CkOAuth2::setCkCodeChallenge(oauth2, 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
    CkOAuth2::setCkScope(oauth2, "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.s = CkOAuth2::ckStartAuth(oauth2)
    If CkOAuth2::ckLastMethodSuccess(oauth2) <> 1
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkSocket::ckDispose(socket)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; 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.i = 0
    While (numMsWaited < 30000) AND (CkOAuth2::ckAuthFlowState(oauth2) < 3)
        CkOAuth2::ckSleepMs(oauth2,100)
        numMsWaited = numMsWaited + 100
    Wend

    ; 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 CkOAuth2::ckAuthFlowState(oauth2) < 3
        CkOAuth2::ckCancel(oauth2)
        Debug "No response from the browser!"
        CkSocket::ckDispose(socket)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; 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 CkOAuth2::ckAuthFlowState(oauth2) = 5
        Debug "OAuth2 failed to complete."
        Debug CkOAuth2::ckFailureInfo(oauth2)
        CkSocket::ckDispose(socket)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    If CkOAuth2::ckAuthFlowState(oauth2) = 4
        Debug "OAuth2 authorization was denied."
        Debug CkOAuth2::ckAccessTokenResponse(oauth2)
        CkSocket::ckDispose(socket)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    If CkOAuth2::ckAuthFlowState(oauth2) <> 3
        Debug "Unexpected AuthFlowState:" + Str(CkOAuth2::ckAuthFlowState(oauth2))
        CkSocket::ckDispose(socket)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    Debug "OAuth2 authorization granted!"
    Debug "Access Token = " + CkOAuth2::ckAccessToken(oauth2)

    ; Get the full JSON response:
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,CkOAuth2::ckAccessTokenResponse(oauth2))
    CkJsonObject::setCkEmitCompact(json, 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 CkJsonObject::ckHasMember(json,"expires_on") <> 1
        dtExpire.i = CkDateTime::ckCreate()
        If dtExpire.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        CkDateTime::ckSetFromCurrentSystemTime(dtExpire)
        CkDateTime::ckAddSeconds(dtExpire,CkJsonObject::ckIntOf(json,"expires_in"))
        CkJsonObject::ckAppendString(json,"expires_on",CkDateTime::ckGetAsUnixTimeStr(dtExpire,0))
    EndIf

    Debug CkJsonObject::ckEmit(json)

    ; Save the JSON to a file for future requests.
    fac.i = CkFileAccess::ckCreate()
    If fac.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkFileAccess::ckWriteEntireTextFile(fac,"qa_data/tokens/microsoftGraph.json",CkJsonObject::ckEmit(json),"utf-8",0)


    CkSocket::ckDispose(socket)
    CkOAuth2::ckDispose(oauth2)
    CkJsonObject::ckDispose(json)
    CkDateTime::ckDispose(dtExpire)
    CkFileAccess::ckDispose(fac)


    ProcedureReturn
EndProcedure