PureBasic

Authorization Code Flow with PKCE for Native Apps

See more Okta OAuth/OIDC Examples

Demonstrates the authorization code flow with Proof Key for Code Exchange (PKCE) for native apps. In Okta, your app should be defined as shown: PureBasic

IncludeFile "CkFileAccess.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkOAuth2.pb"

Procedure ChilkatExample()

    success.i = 0

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

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

    ; This should be the port in the Login redirect URI for your app.  
    ; Your app's Login redirect URI should be "http://localhost:3017/" if the port number is 3017.
    CkOAuth2::setCkListenPort(oauth2, 3017)

    CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://{yourOktaDomain}/oauth2/default/v1/authorize")
    CkOAuth2::setCkTokenEndpoint(oauth2, "https://{yourOktaDomain}/oauth2/default/v1/token")

    ; Replace these with actual values.
    CkOAuth2::setCkClientId(oauth2, "OKTA_CLIENT_ID")
    CkOAuth2::setCkClientSecret(oauth2, "OKTA_CLIENT_SECRET")

    CkOAuth2::setCkCodeChallenge(oauth2, 1)
    CkOAuth2::setCkIncludeNonce(oauth2, 1)

    ; Make sure to include "offline_access" to get a refresh token included in the final JSON response.
    ; Add any additional needed scopes separated by space chars.
    CkOAuth2::setCkScope(oauth2, "openid offline_access")

    ; 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) = 0
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    Debug "URL to load in browser: " + url

    ; Launch the system's default browser navigated to the URL.
    success = CkOAuth2::ckLaunchBrowser(oauth2,url)
    If success = 0
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; Now wait for the authorization.
    ; We'll wait for a max of 60 seconds.
    numMsWaited.i = 0
    While (numMsWaited < 60000) 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!"
        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)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

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

    If CkOAuth2::ckAuthFlowState(oauth2) <> 3
        Debug "Unexpected AuthFlowState:" + Str(CkOAuth2::ckAuthFlowState(oauth2))
        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)
    Debug CkJsonObject::ckEmit(json)

    ; The JSON response looks like this:

    ; {
    ;   "access_token": "eyJraWQi ... Kn4IiEfOw",
    ;   "token_type": "Bearer",
    ;   "expires_in": 3600,
    ;   "scope": "offline_access openid",
    ;   "refresh_token": "0jCqotuuUegdjNzB9uuSsfGM2Cu5HnCHUxoJ0yhZ4rs",
    ;   "id_token": "eyJraWQiO ... 09WGEq3dTRmQF86PzJg"
    ; }

    ; 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/okta.json",CkJsonObject::ckEmit(json),"utf-8",0)


    CkOAuth2::ckDispose(oauth2)
    CkJsonObject::ckDispose(json)
    CkFileAccess::ckDispose(fac)


    ProcedureReturn
EndProcedure