(SQL Server) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- 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.
    DECLARE @socket int
    -- Use "Chilkat_9_5_0.Socket" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Socket', @socket OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Use your HTTP proxy server domain or IP address.
    EXEC sp_OASetProperty @socket, 'HttpProxyHostname', 'myproxyserver.com'
    -- Change this to the listening port of your HTTP proxy server (if necessary)
    EXEC sp_OASetProperty @socket, 'HttpProxyPort', 808
    -- Specify login/password if needed.
    EXEC sp_OASetProperty @socket, 'HttpProxyUsername', 'myProxyLogin'
    EXEC sp_OASetProperty @socket, 'HttpProxyPassword', 'myProxyPassword'
    EXEC sp_OASetProperty @socket, 'HttpProxyForHttp', 1

    DECLARE @oauth2 int
    -- Use "Chilkat_9_5_0.OAuth2" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.OAuth2', @oauth2 OUT

    DECLARE @success int

    -- We don't need to connect the socket beforehand.
    -- Just tell oauth2 to use the socket which has the HTTP proxy properties.
    EXEC sp_OAMethod @oauth2, 'UseConnection', @success OUT, @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.
    EXEC sp_OASetProperty @oauth2, 'ListenPort', 3017

    EXEC sp_OASetProperty @oauth2, 'AuthorizationEndpoint', 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize'
    EXEC sp_OASetProperty @oauth2, 'TokenEndpoint', 'https://login.microsoftonline.com/common/oauth2/v2.0/token'

    -- Replace these with actual values.
    EXEC sp_OASetProperty @oauth2, 'ClientId', 'MICROSOFT-GRAPH-CLIENT-ID'
    -- This is your app password:
    EXEC sp_OASetProperty @oauth2, 'ClientSecret', 'MICROSOFT-GRAPH-CLIENT-SECRET'

    EXEC sp_OASetProperty @oauth2, '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
    EXEC sp_OASetProperty @oauth2, 'Scope', '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.
    DECLARE @url nvarchar(4000)
    EXEC sp_OAMethod @oauth2, 'StartAuth', @url OUT
    EXEC sp_OAGetProperty @oauth2, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        EXEC @hr = sp_OADestroy @oauth2
        RETURN
      END

    -- 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.
    DECLARE @numMsWaited int
    SELECT @numMsWaited = 0
    EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
    WHILE (@numMsWaited < 30000) and (@iTmp0 < 3)
      BEGIN
        EXEC sp_OAMethod @oauth2, 'SleepMs', NULL, 100
        SELECT @numMsWaited = @numMsWaited + 100
      END

    -- 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.
    EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
    IF @iTmp0 < 3
      BEGIN
        EXEC sp_OAMethod @oauth2, 'Cancel', @success OUT

        PRINT 'No response from the browser!'
        EXEC @hr = sp_OADestroy @socket
        EXEC @hr = sp_OADestroy @oauth2
        RETURN
      END

    -- 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.
    EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
    IF @iTmp0 = 5
      BEGIN

        PRINT 'OAuth2 failed to complete.'
        EXEC sp_OAGetProperty @oauth2, 'FailureInfo', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        EXEC @hr = sp_OADestroy @oauth2
        RETURN
      END

    EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
    IF @iTmp0 = 4
      BEGIN

        PRINT 'OAuth2 authorization was denied.'
        EXEC sp_OAGetProperty @oauth2, 'AccessTokenResponse', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        EXEC @hr = sp_OADestroy @oauth2
        RETURN
      END

    EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
    IF @iTmp0 <> 3
      BEGIN

        EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
        PRINT 'Unexpected AuthFlowState:' + @iTmp0
        EXEC @hr = sp_OADestroy @socket
        EXEC @hr = sp_OADestroy @oauth2
        RETURN
      END


    PRINT 'OAuth2 authorization granted!'

    EXEC sp_OAGetProperty @oauth2, 'AccessToken', @sTmp0 OUT
    PRINT 'Access Token = ' + @sTmp0

    -- Get the full JSON response:
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAGetProperty @oauth2, 'AccessTokenResponse', @sTmp0 OUT
    EXEC sp_OAMethod @json, 'Load', @success OUT, @sTmp0
    EXEC sp_OASetProperty @json, '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.
    EXEC sp_OAMethod @json, 'HasMember', @iTmp0 OUT, 'expires_on'
    IF @iTmp0 <> 1
      BEGIN
        DECLARE @dtExpire int
        -- Use "Chilkat_9_5_0.CkDateTime" for versions of Chilkat < 10.0.0
        EXEC @hr = sp_OACreate 'Chilkat.CkDateTime', @dtExpire OUT

        EXEC sp_OAMethod @dtExpire, 'SetFromCurrentSystemTime', @success OUT
        EXEC sp_OAMethod @json, 'IntOf', @iTmp0 OUT, 'expires_in'
        EXEC sp_OAMethod @dtExpire, 'AddSeconds', @success OUT, @iTmp0
        EXEC sp_OAMethod @dtExpire, 'GetAsUnixTimeStr', @sTmp0 OUT, 0
        EXEC sp_OAMethod @json, 'AppendString', @success OUT, 'expires_on', @sTmp0
      END

    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- Save the JSON to a file for future requests.
    DECLARE @fac int
    -- Use "Chilkat_9_5_0.FileAccess" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.FileAccess', @fac OUT

    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    EXEC sp_OAMethod @fac, 'WriteEntireTextFile', @success OUT, 'qa_data/tokens/microsoftGraph.json', @sTmp0, 'utf-8', 0

    EXEC @hr = sp_OADestroy @socket
    EXEC @hr = sp_OADestroy @oauth2
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @dtExpire
    EXEC @hr = sp_OADestroy @fac


END
GO