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

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

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

    const oauth2 = try chilkat.OAuth2.init();
    defer oauth2.deinit();

    // 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.setLocalHost("127.0.0.1");
    oauth2.setListenPort(3017);

    oauth2.setAuthorizationEndpoint("https://x.com/i/oauth2/authorize");
    oauth2.setTokenEndpoint("https://api.x.com/2/oauth2/token");

    // Replace this with your actual X.com OAuth2 Client ID and Client Secret
    oauth2.setClientId("OAUTH2_CLIENT_ID");
    oauth2.setClientSecret("OAUTH2_CLIENT_SECRET");

    // This is for Require Proof Key for Code Exchange (PKCE)
    // See OAuth2 PKCE Explained
    oauth2.setCodeChallenge(true);
    oauth2.setCodeChallengeMethod("S256");

    // Space separated scopes...
    oauth2.setScope("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.
    const url = oauth2.startAuth(alloc) catch {
        std.debug.print("{s}\n", .{try oauth2.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("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.
    oauth2.launchBrowser(url) catch {
        std.debug.print("{s}\n", .{try oauth2.getLastErrorText(alloc)});
        return;
    };

    // Wait for the user to approve or deny authorization in the browser.
    var num_ms_waited: i32 = 0;
    while ((num_ms_waited < 10000) and (oauth2.getAuthFlowState() < 3)) {
        oauth2.sleepMs(100);
        num_ms_waited = num_ms_waited + 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.getAuthFlowState() < 3) {
        oauth2.cancel() catch {};
        std.debug.print("No response from the browser!\n", .{});
        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.getAuthFlowState() == 5) {
        std.debug.print("OAuth2 failed to complete.\n", .{});
        std.debug.print("{s}\n", .{try oauth2.getFailureInfo(alloc)});
        return;
    }

    if (oauth2.getAuthFlowState() == 4) {
        std.debug.print("OAuth2 authorization was denied.\n", .{});
        std.debug.print("{s}\n", .{try oauth2.getAccessTokenResponse(alloc)});
        return;
    }

    if (oauth2.getAuthFlowState() != 3) {
        std.debug.print("Unexpected AuthFlowState:{d}\n", .{oauth2.getAuthFlowState()});
        return;
    }

    std.debug.print("OAuth2 authorization granted!\n", .{});

    const json = try chilkat.JsonObject.init();
    defer json.deinit();
    json.load(try oauth2.getAccessTokenResponse(alloc)) catch {};
    json.setEmitCompact(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 (!json.hasMember("expires_on")) {
        const dt_expire = try chilkat.DateTime.init();
        defer dt_expire.deinit();
        dt_expire.setFromCurrentSystemTime() catch {};
        dt_expire.addSeconds(json.intOf("expires_in")) catch {};
        json.appendString("expires_on", try dt_expire.getAsUnixTimeStr(alloc, false)) catch {};
    }

    std.debug.print("Access Token Response = {s}\n", .{try json.emit(alloc)});

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

    std.debug.print("Access Token = {s}\n", .{try oauth2.getAccessToken(alloc)});

    std.debug.print("Refresh Token = {s}\n", .{try oauth2.getRefreshToken(alloc)});

    // Save the JSON access token response to a file for subsequent use..
    json.writeFile("qa_data/tokens/x.json") catch {};

    // 
}