SQL Server

X.com OAuth 2.0 Authorization Code with PKCE

See more X Examples

Demonstrates how to get an X.com OAuth2 access token from a desktop application or script. SQL Server

-- 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)
    DECLARE @success int
    SELECT @success = 0

    -- For more information about the OAuth2, see OAuth 2.0 Authorization Flow

    DECLARE @oauth2 int
    EXEC @hr = sp_OACreate 'Chilkat.OAuth2', @oauth2 OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- The port should match the Authorized Redirect URL in your X.com app, 
    -- which would look like "http://127.0.0.1:3017/"
    -- See the screenshot below of the App Settings in the X Developer Portal
    EXEC sp_OASetProperty @oauth2, 'LocalHost', '127.0.0.1'
    EXEC sp_OASetProperty @oauth2, 'ListenPort', 3017

    EXEC sp_OASetProperty @oauth2, 'AuthorizationEndpoint', 'https://x.com/i/oauth2/authorize'
    EXEC sp_OASetProperty @oauth2, 'TokenEndpoint', 'https://api.x.com/2/oauth2/token'

    -- Replace this with your actual X.com OAuth2 Client ID and Client Secret
    EXEC sp_OASetProperty @oauth2, 'ClientId', 'OAUTH2_CLIENT_ID'
    EXEC sp_OASetProperty @oauth2, 'ClientSecret', 'OAUTH2_CLIENT_SECRET'

    -- This is for Require Proof Key for Code Exchange (PKCE)
    -- See OAuth2 PKCE Explained
    EXEC sp_OASetProperty @oauth2, 'CodeChallenge', 1
    EXEC sp_OASetProperty @oauth2, 'CodeChallengeMethod', 'S256'

    -- Space separated scopes...
    EXEC sp_OASetProperty @oauth2, 'Scope', 'tweet.read tweet.write users.read follows.read follows.write offline.access like.read like.write block.read block.write'

    -- Begin the OAuth2 Authorization code 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 @oauth2
        RETURN
      END


    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.
    EXEC sp_OAMethod @oauth2, 'LaunchBrowser', @success OUT, @url
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @oauth2
        RETURN
      END

    -- Wait for the user to approve or deny authorization in the browser.
    DECLARE @numMsWaited int
    SELECT @numMsWaited = 0
    EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
    WHILE (@numMsWaited < 10000) and (@iTmp0 < 3)
      BEGIN
        EXEC sp_OAMethod @oauth2, 'SleepMs', NULL, 100
        SELECT @numMsWaited = @numMsWaited + 100
      END

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

    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 @oauth2
        RETURN
      END

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

    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 @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 @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 @oauth2
        RETURN
      END


    PRINT 'OAuth2 authorization granted!'

    DECLARE @json int
    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

    -- 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 = 0
      BEGIN
        DECLARE @dtExpire int
        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 'Access Token Response = ' + @sTmp0

    -- A sample access token response:

    -- {
    --   "token_type": "bearer",
    --   "expires_in": 7200,
    --   "access_token": "VmNDLVZiYUZwejY5Mkx3RblFTmo3ek1leTRGclMuZFVOUTVUTWpNbVZKb1N5OjE3NDAxNjk4MDVxNTE6MToxOaF0OjE",
    --   "scope": "block.read follows.read offline.access tweet.write block.write like.write like.read users.read tweet.read follows.write",
    --   "refresh_token": "eThOWVVFSTRqdVp3QTFndGsxM2ZGZmFyNWVrU0phM1JKbGdrbGNWRGJzb1loOjE3NDAwMjk4MDUxNTI6MTowOnJ0OjE"
    -- }


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


    EXEC sp_OAGetProperty @oauth2, 'RefreshToken', @sTmp0 OUT
    PRINT 'Refresh Token = ' + @sTmp0

    -- Save the JSON access token response to a file for subsequent use..
    EXEC sp_OAMethod @json, 'WriteFile', @success OUT, 'qa_data/tokens/x.json'

    -- 

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


END
GO