Lua Requires Chilkat v10.1.2+

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

local chilkat = require("chilkat")

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

local oauth2 = chilkat.OAuth2.new()

-- 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
oauth2.local_host = "127.0.0.1"
oauth2.listen_port = 3017

oauth2.authorization_endpoint = "https://x.com/i/oauth2/authorize"
oauth2.token_endpoint = "https://api.x.com/2/oauth2/token"

-- Replace this with your actual X.com OAuth2 Client ID and Client Secret
oauth2.client_id = "OAUTH2_CLIENT_ID"
oauth2.client_secret = "OAUTH2_CLIENT_SECRET"

-- This is for Require Proof Key for Code Exchange (PKCE)
-- See OAuth2 PKCE Explained
oauth2.code_challenge = true
oauth2.code_challenge_method = "S256"

-- Space separated scopes...
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.
local url = oauth2:start_auth()
if not oauth2.last_method_success then
    print(oauth2.last_error_text)
    return
end

print("url = " .. url)

-- Launch the default browser on the system and navigate to the url.
local success = oauth2:launch_browser(url)
if not success then
    print(oauth2.last_error_text)
    return
end

-- Wait for the user to approve or deny authorization in the browser.
local numMsWaited = 0
while (numMsWaited < 10000) and (oauth2.auth_flow_state < 3) do
    oauth2:sleep_ms(100)
    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.

if oauth2.auth_flow_state < 3 then
    oauth2:cancel()
    print("No response from the browser!")
    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.

if oauth2.auth_flow_state == 5 then
    print("OAuth2 failed to complete.")
    print(oauth2.failure_info)
    return
end

if oauth2.auth_flow_state == 4 then
    print("OAuth2 authorization was denied.")
    print(oauth2.access_token_response)
    return
end

if oauth2.auth_flow_state ~= 3 then
    print("Unexpected AuthFlowState:" .. oauth2.auth_flow_state)
    return
end

print("OAuth2 authorization granted!")

local json = chilkat.JsonObject.new()
json:load(oauth2.access_token_response)
json.emit_compact = false

-- 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 not json:has_member("expires_on") then
    local dtExpire = chilkat.DateTime.new()
    dtExpire:set_from_current_system_time()
    dtExpire:add_seconds(json:int_of("expires_in"))
    json:append_string("expires_on", dtExpire:get_as_unix_time_str(false))
end

print("Access Token Response = " .. json:emit())

-- 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"
-- }

print("Access Token = " .. oauth2.access_token)

print("Refresh Token = " .. oauth2.refresh_token)

-- Save the JSON access token response to a file for subsequent use..
json:write_file("qa_data/tokens/x.json")

--