C

OAuth2 using a SOCKS Proxy (for a Desktop Application)

See more OAuth2 Examples

Explains how to use a SOCKS proxy to send OAuth2 communications for a desktop application, using Microsoft Graph as an example. This method applies to all OAuth2 applications. C

#include <C_CkSocket.h>
#include <C_CkOAuth2.h>
#include <C_CkJsonObject.h>
#include <C_CkDateTime.h>
#include <C_CkFileAccess.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSocket socket;
    HCkOAuth2 oauth2;
    const char *url;
    int numMsWaited;
    HCkJsonObject json;
    HCkDateTime dtExpire;
    HCkFileAccess fac;

    success = FALSE;

    //  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 = CkSocket_Create();
    //  Use your SOCKS proxy server domain or IP address.
    CkSocket_putSocksHostname(socket,"mysocksproxyserver.com");
    //  Change this to the listening port of your SOCKS proxy server (if necessary)
    CkSocket_putSocksPort(socket,1080);
    CkSocket_putSocksUsername(socket,"myProxyLogin");
    CkSocket_putSocksPassword(socket,"myProxyPassword");
    //  Set the SOCKS version to 4 or 5 based on the version
    //  of the SOCKS proxy server:
    CkSocket_putSocksVersion(socket,5);
    //  Note: SOCKS4 servers only support usernames without passwords.
    //  SOCKS5 servers support full login/password authentication.

    oauth2 = CkOAuth2_Create();

    //  We don't need to connect the socket beforehand.
    //  Just tell oauth2 to use the socket which has the SOCKS proxy properties.
    success = CkOAuth2_UseConnection(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_putListenPort(oauth2,3017);

    CkOAuth2_putAuthorizationEndpoint(oauth2,"https://login.microsoftonline.com/common/oauth2/v2.0/authorize");
    CkOAuth2_putTokenEndpoint(oauth2,"https://login.microsoftonline.com/common/oauth2/v2.0/token");

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

    CkOAuth2_putCodeChallenge(oauth2,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
    CkOAuth2_putScope(oauth2,"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.
    url = CkOAuth2_startAuth(oauth2);
    if (CkOAuth2_getLastMethodSuccess(oauth2) != TRUE) {
        printf("%s\n",CkOAuth2_lastErrorText(oauth2));
        CkSocket_Dispose(socket);
        CkOAuth2_Dispose(oauth2);
        return;
    }

    printf("url = %s\n",url);

    //  Launch the default browser on the system and navigate to the url.
    //  The LaunchBrowser method was added in Chilkat v10.1.2.
    success = CkOAuth2_LaunchBrowser(oauth2,url);
    if (success == FALSE) {
        printf("%s\n",CkOAuth2_lastErrorText(oauth2));
        CkSocket_Dispose(socket);
        CkOAuth2_Dispose(oauth2);
        return;
    }

    //  Wait for the user to approve or deny authorization in the browser.
    numMsWaited = 0;
    while ((numMsWaited < 90000) && (CkOAuth2_getAuthFlowState(oauth2) < 3)) {
        CkOAuth2_SleepMs(oauth2,100);
        numMsWaited = numMsWaited + 100;
    }

    //  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 (CkOAuth2_getAuthFlowState(oauth2) < 3) {
        CkOAuth2_Cancel(oauth2);
        printf("No response from the browser!\n");
        CkSocket_Dispose(socket);
        CkOAuth2_Dispose(oauth2);
        return;
    }

    //  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 (CkOAuth2_getAuthFlowState(oauth2) == 5) {
        printf("OAuth2 failed to complete.\n");
        printf("%s\n",CkOAuth2_failureInfo(oauth2));
        CkSocket_Dispose(socket);
        CkOAuth2_Dispose(oauth2);
        return;
    }

    if (CkOAuth2_getAuthFlowState(oauth2) == 4) {
        printf("OAuth2 authorization was denied.\n");
        printf("%s\n",CkOAuth2_accessTokenResponse(oauth2));
        CkSocket_Dispose(socket);
        CkOAuth2_Dispose(oauth2);
        return;
    }

    if (CkOAuth2_getAuthFlowState(oauth2) != 3) {
        printf("Unexpected AuthFlowState:%d\n",CkOAuth2_getAuthFlowState(oauth2));
        CkSocket_Dispose(socket);
        CkOAuth2_Dispose(oauth2);
        return;
    }

    printf("OAuth2 authorization granted!\n");
    printf("Access Token = %s\n",CkOAuth2_accessToken(oauth2));

    //  Get the full JSON response:
    json = CkJsonObject_Create();
    CkJsonObject_Load(json,CkOAuth2_accessTokenResponse(oauth2));
    CkJsonObject_putEmitCompact(json,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 (CkJsonObject_HasMember(json,"expires_on") != TRUE) {
        dtExpire = CkDateTime_Create();
        CkDateTime_SetFromCurrentSystemTime(dtExpire);
        CkDateTime_AddSeconds(dtExpire,CkJsonObject_IntOf(json,"expires_in"));
        CkJsonObject_AppendString(json,"expires_on",CkDateTime_getAsUnixTimeStr(dtExpire,FALSE));
    }

    printf("%s\n",CkJsonObject_emit(json));

    //  Save the JSON to a file for future requests.
    fac = CkFileAccess_Create();
    CkFileAccess_WriteEntireTextFile(fac,"qa_data/tokens/microsoftGraph.json",CkJsonObject_emit(json),"utf-8",FALSE);


    CkSocket_Dispose(socket);
    CkOAuth2_Dispose(oauth2);
    CkJsonObject_Dispose(json);
    CkDateTime_Dispose(dtExpire);
    CkFileAccess_Dispose(fac);

    }