Skip to content

WIP: Update plugin auth #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
MKuijpers wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

WIP: Update plugin auth #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7b0810
Add fetchToken method to fetch access token using the new OP Auth flow
MKuijpers Apr 15, 2023
06bf039
Cleanup API requests and remove old auth code
MKuijpers Apr 15, 2023
9a3472d
Merge branch 'master' into update-plugin-auth
MKuijpers Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 86 additions & 75 deletions Api/Api.as
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,109 +1,120 @@
namespace Api {

void fetchAccessTokenAsync() {
if (AccessToken != "") {
print("Access token already set, skipping authentication.");
return;
}

// Start the task to get the token from Openplanet
print("Getting token from Openplanet");
Auth::PluginAuthTask@ tokenTask = Auth::GetToken();

// Wait until the task has finished
while (!tokenTask.Finished()) {
yield();
}

// Take the token
string token = tokenTask.Token();
trace("Token: \"" + token + "\"");

// Send it to the shoutbox server
Net::HttpRequest@ req = Net::HttpPost(
ApiUrl + "/auth/login/plugin" + "?pluginVersion=" + g_dojo.version,
"token=" + Net::UrlEncode(token)
);
while (!req.Finished()) {
yield();
}

if (req.ResponseCode() != 200 && req.ResponseCode() != 201) {
error("Unable to authenticate, http error " + req.ResponseCode());
return;
}

// Parse the server response
Json::Value json = Json::Parse(req.String());

// Keep track of our information, including a secret that we can use to authenticate ourselves with the shoutbox server
// g_accountID = js["account_id"];
// g_displayName = js["display_name"];
AccessToken = json["access_token"];
}

// Workaround method for checkServer to ensure checkServer is only called when webId and playerLogin are not the equal
void checkServerWaitForValidWebId() {
void authenticatePluginWaitForValidWebId() {
while (g_dojo.network.PlayerInfo.Login == g_dojo.network.PlayerInfo.WebServicesUserId) {
sleep(50);
yield();
}

startnew(Api::checkServer);
startnew(Api::authenticatePlugin);
}

void checkServer() {
void authenticatePlugin() {
g_dojo.checkingServer = true;

g_dojo.playerName = g_dojo.network.PlayerInfo.Name;
g_dojo.playerLogin = g_dojo.network.PlayerInfo.Login;
g_dojo.webId = g_dojo.network.PlayerInfo.WebServicesUserId;

Net::HttpRequest@ auth = Net::HttpGet(ApiUrl + "/auth?name=" + g_dojo.playerName + "&login=" + g_dojo.playerLogin + "&webid=" + g_dojo.webId + "&sessionId=" + SessionId + "&pluginVersion=" + g_dojo.version);
while (!auth.Finished()) {
fetchAccessTokenAsync();

Net::HttpRequest@ req = Net::HttpRequest();
req.Method = Net::HttpMethod::Get;
req.Url = ApiUrl + "/auth/me" + "?pluginVersion=" + g_dojo.version;
req.Headers["Authorization"] = "Bearer " + AccessToken;
req.Start();

print("Starting /auth/me request...");
while (!req.Finished()) {
yield();
sleep(50);
}
if (auth.String().get_Length() > 0) {
Json::Value json = Json::Parse(auth.String());

if (json.GetType() != Json::Type::Null) {
print("HasKey authUrl: " + json.HasKey("authURL"));
print("HasKey authSuccess: " + json.HasKey("authSuccess"));

if (json.HasKey("authURL")) {
try {
g_dojo.pluginAuthUrl = json["authURL"];
ClientCode = json["clientCode"];
SessionId = "";
UI::ShowNotification("TMDojo", "Plugin needs authentication!\n\nF3 → Scripts → TMDojo → Authenticate Plugin", 10000);
} catch {
error("checkServer json error");
}
}
if (json.HasKey("authSuccess")) {
g_dojo.pluginAuthed = true;
UI::ShowNotification("TMDojo", "Plugin is authenticated!", SUCCESS_COLOR);
}
} else {
UI::ShowNotification("TMDojo", "checkServer() Error: Json response is null", ERROR_COLOR);
}

if (req.ResponseCode() == 200) {
g_dojo.pluginAuthed = true;
print("Plugin authenticated!");

g_dojo.serverAvailable = true;
// Parse server response and display welcome message
Json::Value json = Json::Parse(req.String());
string playerName = json["playerName"];
UI::ShowNotification("TMDojo", "Plugin authenticated!\n\nWelcome, " + playerName + "!", SUCCESS_COLOR);
} else {
g_dojo.serverAvailable = false;
g_dojo.pluginAuthed = false;
UI::ShowNotification("TMDojo", "Plugin authentication failed. Error code: " + req.ResponseCode(), ERROR_COLOR);
print("Plugin authentication failed, status code: " + req.ResponseCode());
}

g_dojo.serverAvailable = req.String().Length > 0;

g_dojo.checkingServer = false;
}

void logout() {
string logoutBody = "{\"sessionId\":\"" + SessionId + "\"}";
Net::HttpRequest@ req = Net::HttpPost(ApiUrl + "/logout?pluginVersion=" + g_dojo.version, logoutBody, "application/json");
// Setup logout request
Net::HttpRequest@ req = Net::HttpRequest();
req.Method = Net::HttpMethod::Post;
req.Url = ApiUrl + "/auth/logout" + "?pluginVersion=" + g_dojo.version;
req.Headers["Authorization"] = "Bearer " + AccessToken;
req.Start();

// Wait until the request has finished
while (!req.Finished()) {
yield();
sleep(50);
}

// Notify user if logout failed
int status = req.ResponseCode();
if (status == 200) {
UI::ShowNotification("TMDojo", "Plugin logged out!", SUCCESS_COLOR);
SessionId = "";
g_dojo.pluginAuthed = false;
startnew(Api::checkServerWaitForValidWebId);
} else {
if (status != 200 && status != 201) {
UI::ShowNotification("TMDojo", "Failed to logout, please try again!", ERROR_COLOR);
return;
}
}

void authenticatePlugin() {
OpenBrowserURL(g_dojo.pluginAuthUrl);
startnew(getPluginAuth);
}

void getPluginAuth() {
g_dojo.isAuthenticating = true;
while (g_dojo.checkSessionIdCount < MAX_CHECK_SESSION_ID) {
sleep(1000);
g_dojo.checkSessionIdCount++;
Net::HttpRequest@ auth = Net::HttpGet(ApiUrl + "/auth/pluginSecret?clientCode=" + ClientCode+ "&pluginVersion=" + g_dojo.version);
while (!auth.Finished()) {
yield();
sleep(50);
}
try {
Json::Value json = Json::Parse(auth.String());
SessionId = json["sessionId"];
UI::ShowNotification("TMDojo", "Plugin is authenticated!", SUCCESS_COLOR, 10000);
g_dojo.pluginAuthed = true;
g_dojo.checkSessionIdCount = 0;
ClientCode = "";
break;
} catch {

}
}
g_dojo.isAuthenticating = false;
if (g_dojo.checkSessionIdCount >= MAX_CHECK_SESSION_ID) {
UI::ShowNotification("TMDojo", "Plugin authentication took too long, please try again", ERROR_COLOR, 10000);
g_dojo.checkSessionIdCount = 0;
}
// Notify user of logout and update fields
UI::ShowNotification("TMDojo", "Plugin logged out!", SUCCESS_COLOR);
AccessToken = "";
g_dojo.pluginAuthed = false;
}

// Parse list of uint values as a string joined by a comma delimiter
Expand Down Expand Up @@ -193,7 +204,7 @@ namespace Api {

// Build headers
dictionary@ Headers = dictionary();
Headers["Authorization"] = "dojo " + SessionId;
Headers["Authorization"] = "Bearer " + AccessToken;
Headers["Content-Type"] = "application/octet-stream";
@req.Headers = Headers;

Expand Down
10 changes: 3 additions & 7 deletions Lib/Dojo.as
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,6 @@ class TMDojo
bool serverAvailable = false;
bool checkingServer = false;

// Session
int checkSessionIdCount = 0;
int maxCheckSessionId = 60;

// Plugin info
Meta::Plugin@ plugin = Meta::ExecutingPlugin();
string version = plugin.Version;
Expand All @@ -41,7 +37,7 @@ class TMDojo
TMDojo() {
auto app = GetApp();
@network = cast<CTrackManiaNetwork>(app.Network);
startnew(Api::checkServerWaitForValidWebId);
startnew(Api::authenticatePluginWaitForValidWebId);
}

void Reset() {
Expand Down Expand Up @@ -112,8 +108,8 @@ class TMDojo

void Update(float dt)
{
// Do not start recording if the user is not authenticated or doesn't even have a SessionId
if (!pluginAuthed || SessionId == "") {
// Do not start recording if the user is not authenticated or doesn't have a AccessToken
if (!pluginAuthed || AccessToken == "") {
return;
}

Expand Down
5 changes: 1 addition & 4 deletions UI/AuthWindow.as
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,7 @@ void renderAuthWindow() {
UI::Text("If it takes a bit longer, you can just press the button again (if you're already logged in, it's just gonna take a second).");
UI::Text("");
if (!g_dojo.isAuthenticating && UI::Button("Authenticate Plugin")) {
Api::authenticatePlugin();
}
if (g_dojo.isAuthenticating) {
UI::Text("Awaiting authentication, " + (MAX_CHECK_SESSION_ID - g_dojo.checkSessionIdCount) + " seconds remaining");
startnew(Api::authenticatePlugin);
}
} else {
UI::Text(GREEN + "Plugin authed!");
Expand Down
6 changes: 3 additions & 3 deletions UI/Menu.as
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ void RenderMenu()
if (UI::MenuItem(Enabled ? "Turn OFF" : "Turn ON", "", false, true)) {
Enabled = !Enabled;
if (Enabled) {
startnew(Api::checkServerWaitForValidWebId);
startnew(Api::authenticatePluginWaitForValidWebId);
}
}

Expand All @@ -32,7 +32,7 @@ void RenderMenu()
if (DevMode && UI::MenuItem("Switch to " + otherApi + " " + otherUi , "", false, true)) {
ApiUrl = otherApi;
UiUrl = otherUi;
startnew(Api::checkServerWaitForValidWebId);
startnew(Api::authenticatePluginWaitForValidWebId);
}

if (UI::MenuItem(CheckMarkWithLabel(OverlayEnabled, "Overlay"), "", false, true)) {
Expand All @@ -49,7 +49,7 @@ void RenderMenu()

if (!g_dojo.serverAvailable && !g_dojo.checkingServer) {
if (UI::MenuItem("Check server", "", false, true)) {
startnew(Api::checkServerWaitForValidWebId);
startnew(Api::authenticatePluginWaitForValidWebId);
}
}

Expand Down
7 changes: 2 additions & 5 deletions Utils/Settings.as
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,8 @@ string ApiUrl = REMOTE_API;
[Setting name="TMDojoUiUrl" description="TMDojo Ui Url"]
string UiUrl = REMOTE_UI;

[Setting password name="TMDojoClientCode" description="TMDojo plugin Client Code"]
string ClientCode = "";

[Setting password name="TMDojoSessionId" description="TMDojo plugin SessionId"]
string SessionId = "";
[Setting password name="TMDojoAccessToken" description="TMDojo plugin AccessToken"]
string AccessToken = "";

[Setting name="TMDojoDebugOverlayEnabled" description="Enable / Disable debug overlay"]
bool DebugOverlayEnabled = false;
Expand Down