Swift

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. Swift

func chilkatTest() {
    var success: Bool = 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).
    let socket = CkoSocket()!
    // Use your SOCKS proxy server domain or IP address.
    socket.socksHostname = "mysocksproxyserver.com"
    // Change this to the listening port of your SOCKS proxy server (if necessary)
    socket.socksPort = 1080
    socket.socksUsername = "myProxyLogin"
    socket.socksPassword = "myProxyPassword"
    // Set the SOCKS version to 4 or 5 based on the version
    // of the SOCKS proxy server:
    socket.socksVersion = 5
    // Note: SOCKS4 servers only support usernames without passwords.
    // SOCKS5 servers support full login/password authentication.

    let oauth2 = CkoOAuth2()!

    // 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(sock: 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.listenPort = 3017

    oauth2.authorizationEndpoint = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"
    oauth2.tokenEndpoint = "https://login.microsoftonline.com/common/oauth2/v2.0/token"

    // Replace these with actual values.
    oauth2.clientId = "MICROSOFT-GRAPH-CLIENT-ID"
    // This is your app password:
    oauth2.clientSecret = "MICROSOFT-GRAPH-CLIENT-SECRET"

    oauth2.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.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.
    var url: String? = oauth2.startAuth()
    if oauth2.lastMethodSuccess != true {
        print("\(oauth2.lastErrorText!)")
        return
    }

    print("url = \(url!)")

    // Launch the default browser on the system and navigate to the url.
    // The LaunchBrowser method was added in Chilkat v10.1.2.
    success = oauth2.launchBrowser(url: url)
    if success == false {
        print("\(oauth2.lastErrorText!)")
        return
    }

    // Wait for the user to approve or deny authorization in the browser.
    var numMsWaited: Int = 0
    while (numMsWaited < 90000) && (oauth2.authFlowState.intValue < 3) {
        oauth2.sleepMs(millisec: 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 oauth2.authFlowState.intValue < 3 {
        oauth2.cancel()
        print("No response from the browser!")
        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 oauth2.authFlowState.intValue == 5 {
        print("OAuth2 failed to complete.")
        print("\(oauth2.failureInfo!)")
        return
    }

    if oauth2.authFlowState.intValue == 4 {
        print("OAuth2 authorization was denied.")
        print("\(oauth2.accessTokenResponse!)")
        return
    }

    if oauth2.authFlowState.intValue != 3 {
        print("Unexpected AuthFlowState:\(oauth2.authFlowState.intValue)")
        return
    }

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

    // Get the full JSON response:
    let json = CkoJsonObject()!
    json.load(json: oauth2.accessTokenResponse)
    json.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(jsonPath: "expires_on") != true {
        let dtExpire = CkoDateTime()!
        dtExpire.setFromCurrentSystemTime()
        dtExpire.addSeconds(numSeconds: json.int(of: "expires_in").intValue)
        json.appendString(name: "expires_on", value: dtExpire.get(asUnixTimeStr: false))
    }

    print("\(json.emit()!)")

    // Save the JSON to a file for future requests.
    let fac = CkoFileAccess()!
    fac.writeEntireTextFile(path: "qa_data/tokens/microsoftGraph.json", fileData: json.emit(), charset: "utf-8", includePreamble: false)

}