🎉 Begin a project

.gitignore

@@ -4,6 +4,15 @@
 # Log file
 *.log
 
+# Intellij
+.idea
+
+# Build file
+build
+
+# Output of the build
+out
+
 # BlueJ files
 *.ctxt
 
@@ -21,3 +30,7 @@
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+
+# Ignore Gradle project-specific cache directory
+.gradle/
+local.properties

README.md

@@ -1,2 +1,59 @@
-# GCAuth_OAuth
+# GCAuth OAuth
-The in-game login system for Grasscutter is based on oauth and GCAuth.
+
+The in-game login system for [Grasscutter](https://github.com/Grasscutters/Grasscutter) is based on oauth and [GCAuth](https://github.com/exzork/GCAuth).
+
+## Current Features:
+
+- [x] Use twitter oauth to login
+- [ ] Error page
+
+## Important Notes:
+
+This plugin is made to run on the current [Development](https://github.com/Grasscutters/Grasscutter/tree/development) branch of Grasscutter. \
+
+This plugin is in very early development and only have the backend now. Frontend is extermely hardcore.
+
+## Setup
+
+### Download Plugin Jar
+
+See releases.
+
+### Compile yourself
+
+1. Pull the latest code from github using ``git clone https://github.com/Xtao-Team/GCAuth-OAuth`` in your terminal of choice.
+2. Locate your grasscutter server and copy the ``grasscutter`` server jar into the newly created ``GCAuth-OAuth/lib`` folder
+3. Navigate back into the project root folder called ``GCAuth-OAuth`` folder and run ``gradlew build`` (cmd) **or** ``./gradlew build`` (Powershell, Linux & Mac).
+4. Assuming the build succeeded, in your file explorer navigate to the ``GCAuth-OAuth`` folder, you should have a ``gcauth_oauth.jar`` file, copy it.
+5. Navigate to your ``Grasscutter`` server, find the ``plugins`` folder and paste the ``gcauth_oauth.jar`` into it.
+6. Start your server.
+
+...Jump to next section...
+
+### Usage
+
+7. Put the all the [frontend](#Frontend) files into the folder `GRASSCUTTER_RESOURCE/plugins/GCAuth/OAuth`. Note that your must have `login.html` for now. You are free to put any other dynamiclly loaded file(e.g. `.js`, `.css`) in that folder. Check the last section for current available frontend.
+
+8. Put the ``gcauth.jar`` file into the ``plugins`` folder of your grasscutter server. [GCAuth](https://github.com/exzork/GCAuth)
+
+9. Log in to your server and you should be able to log in with Twitter account. (make sure `webapi-os.account.hoyoverse.com` is in your proxy list)
+
+Your final plugins' folder's directory structure should look similar to this
+```
+plugins
+│   gcauth.jar
+│   gcauth_oauth.jar
+│   ...
+└───GCAuth
+    │   config.json
+    └───OAuth
+        │   login.html
+        │   ...
+```
+
+### Frontend
+
+[en](https://github.com/Xtao-Team/GCAuth-OAuth/tree/en) [zh](https://github.com/Xtao-Team/GCAuth-OAuth/tree/zh)
+
+- [x] Login page
+- [ ] Error page

build.gradle

@@ -0,0 +1,31 @@
+buildscript {
+
+}
+
+plugins {
+    id 'java'
+}
+
+sourceCompatibility = 17
+targetCompatibility = 17
+
+group 'com.xtaolabs.gcauth_oauth'
+version '1.0.0'
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation files('lib/grasscutter-1.1.1-dev.jar')
+    implementation files('lib/gcauth-2.1.5.jar')
+}
+
+test {
+    useJUnitPlatform()
+}
+
+jar{
+    jar.baseName = 'gcauth_oauth'
+    destinationDir = file(".")
+}

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradlew

@@ -0,0 +1,234 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+#
+#   Gradle start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh Gradle
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "$app_path" ]
+do
+    ls=$( ls -ld "$app_path" )
+    link=${ls#*' -> '}
+    case $link in             #(
+      /*)   app_path=$link ;; #(
+      *)    app_path=$APP_HOME$link ;;
+    esac
+done
+
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+
+APP_NAME="Gradle"
+APP_BASE_NAME=${0##*/}
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+    echo "$*"
+} >&2
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in                #(
+  CYGWIN* )         cygwin=true  ;; #(
+  Darwin* )         darwin=true  ;; #(
+  MSYS* | MINGW* )  msys=true    ;; #(
+  NONSTOP* )        nonstop=true ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD=$JAVA_HOME/jre/sh/java
+    else
+        JAVACMD=$JAVA_HOME/bin/java
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD=java
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        ulimit -n "$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to $MAX_FD"
+    esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+    JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case $arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
+                    [ -e "$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=$( cygpath --path --ignore --mixed "$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "$@" "$arg"      # push replacement arg
+    done
+fi
+
+# Collect all arguments for the java command;
+#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
+#     shell script including quotes and variable substitutions, so put them in
+#     double quotes to make sure that they get re-expanded; and
+#   * put everything else in single quotes, so that it's not re-expanded.
+
+set -- \
+        "-Dorg.gradle.appname=$APP_BASE_NAME" \
+        -classpath "$CLASSPATH" \
+        org.gradle.wrapper.GradleWrapperMain \
+        "$@"
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+#   set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+        tr '\n' ' '
+    )" '"$@"'
+
+exec "$JAVACMD" "$@"

gradlew.bat

@@ -0,0 +1,89 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

settings.gradle

@@ -0,0 +1 @@
+rootProject.name = 'GCAuth_OAuth'

src/main/java/com/xtaolabs/gcauth_oauth/GCAuth_OAuth.java

@@ -0,0 +1,55 @@
+package com.xtaolabs.gcauth_oauth;
+
+import emu.grasscutter.Grasscutter;
+import emu.grasscutter.plugin.Plugin;
+import emu.grasscutter.server.dispatch.DispatchHttpJsonHandler;
+import static emu.grasscutter.Configuration.*;
+
+import com.xtaolabs.gcauth_oauth.handler.VerifyHandler;
+import com.xtaolabs.gcauth_oauth.handler.RequestHandler;
+
+import express.Express;
+
+import io.javalin.http.staticfiles.Location;
+
+import java.io.File;
+
+
+public class GCAuth_OAuth extends Plugin {
+    @Override
+    public void onEnable() {
+        String Login_Html_Path = PLUGINS_FOLDER + "/GCAuth/OAuth/login.html";
+        File Login_Html = new File(Login_Html_Path);
+        if(!Login_Html.exists()) {
+            Grasscutter.getLogger().warn(String.format("[GCAuth_OAuth] %s not found", Login_Html_Path));
+        } else {
+            loadTwitterLogin();
+            Grasscutter.getLogger().info("[GCAuth_OAuth] Enabled");
+        }
+    }
+
+    @Override
+    public void onDisable() {
+        Express app = Grasscutter.getDispatchServer().getServer();
+        app.disable("/Api/twitter_login");
+        Grasscutter.getLogger().info("[GCAuth_OAuth] Disabled");
+    }
+
+    public void loadTwitterLogin() {
+        String folder_name = PLUGINS_FOLDER + "/GCAuth/OAuth/";
+        Express app = Grasscutter.getDispatchServer().getServer();
+
+        app.get("/Api/twitter_login", new DispatchHttpJsonHandler(
+                String.format("{\"code\":200,\"data\":{\"auth_url\":\"%s\",\"info\":\"\",\"msg\":\"Success\",\"status\":1}}",
+                        "http" + (DISPATCH_ENCRYPTION.useEncryption ? "s" : "") + "://"
+                                + lr(DISPATCH_INFO.accessAddress, DISPATCH_INFO.bindAddress) + ":"
+                                + lr(DISPATCH_INFO.accessPort, DISPATCH_INFO.bindPort) + "/gcauth_oauth/login.html")
+        ));
+
+        app.post("/gcauth_oauth/login", new RequestHandler());
+
+        app.post("/hk4e_global/mdk/shield/api/loginByThirdparty", new VerifyHandler());
+
+        app.raw().config.addStaticFiles("/gcauth_oauth", folder_name, Location.EXTERNAL);
+    }
+}

src/main/java/com/xtaolabs/gcauth_oauth/handler/RequestHandler.java

@@ -0,0 +1,35 @@
+package com.xtaolabs.gcauth_oauth.handler;
+
+import java.io.IOException;
+
+import emu.grasscutter.game.Account;
+import express.http.HttpContextHandler;
+import express.http.Request;
+import express.http.Response;
+
+import me.exzork.gcauth.utils.Authentication;
+
+
+public final class RequestHandler implements HttpContextHandler {
+    @Override
+    public void handle(Request req, Response res) throws IOException {
+        String username = req.formData("username");
+        String password = req.formData("password");
+
+        if (username.isEmpty() || password.isEmpty()) {
+            res.send("Error: Username or password is empty");
+            return;
+        }
+        Account account = Authentication.getAccountByUsernameAndPassword(username, password);
+        if (account == null) {
+            res.send("Error: Username or password is incorrect");
+            return;
+        }
+        if (account.getPassword() != null && !account.getPassword().isEmpty()) {
+            res.send(String.format("<meta http-equiv=\"refresh\" content=\"0;url=uniwebview://sdkThirdLogin?accessToken=%s\">",
+                    Authentication.generateJwt(account)));
+        } else {
+            res.send("Error: Account is not registered");
+        }
+    }
+}

src/main/java/com/xtaolabs/gcauth_oauth/handler/VerifyHandler.java

@@ -0,0 +1,47 @@
+package com.xtaolabs.gcauth_oauth.handler;
+
+import java.io.IOException;
+
+import com.auth0.jwt.interfaces.DecodedJWT;
+import com.xtaolabs.gcauth_oauth.json.VerifyJson;
+import com.xtaolabs.gcauth_oauth.utils.parse;
+import emu.grasscutter.Grasscutter;
+import emu.grasscutter.game.Account;
+import emu.grasscutter.server.dispatch.json.LoginResultJson;
+import express.http.HttpContextHandler;
+import express.http.Request;
+import express.http.Response;
+import me.exzork.gcauth.utils.Authentication;
+
+
+public final class VerifyHandler implements HttpContextHandler {
+    @Override
+    public void handle(Request req, Response res) throws IOException {
+        VerifyJson request = req.body(VerifyJson.class);
+        LoginResultJson responseData = new LoginResultJson();
+        DecodedJWT jwt = parse.deToken(request.access_token);
+        Account account = null;
+        if (jwt != null) {
+            account = Authentication.getAccountByOneTimeToken(jwt.getClaim("token").asString());
+        }
+        // Login
+        if(account == null) {
+            Grasscutter.getLogger().info("[GCAuth] Client " + req.ip() + " failed to log in");
+            responseData.retcode = -201;
+            responseData.message = "Token is invalid";
+            res.send(responseData);
+            return;
+        }
+
+        // Account was found, log the player in
+        responseData.message = "OK";
+        responseData.data.account.uid = account.getId();
+        responseData.data.account.token = account.generateSessionKey();
+        responseData.data.account.email = account.getEmail();
+        responseData.data.account.twitter_name = account.getUsername();
+
+        Grasscutter.getLogger().info(String.format("[GCAuth] Client %s logged in as %s", req.ip(), responseData.data.account.uid));
+
+        res.send(responseData);
+    }
+}

src/main/java/com/xtaolabs/gcauth_oauth/json/VerifyJson.java

@@ -0,0 +1,8 @@
+package com.xtaolabs.gcauth_oauth.json;
+
+public final class VerifyJson {
+    public String thirdparty;
+    public String access_token;
+    public String cb_url;
+    public Boolean no_regist;
+}

src/main/java/com/xtaolabs/gcauth_oauth/utils/parse.java

@@ -0,0 +1,23 @@
+package com.xtaolabs.gcauth_oauth.utils;
+
+import com.auth0.jwt.JWT;
+import com.auth0.jwt.JWTVerifier;
+import com.auth0.jwt.exceptions.JWTVerificationException;
+import com.auth0.jwt.interfaces.DecodedJWT;
+
+import static me.exzork.gcauth.utils.Authentication.getKey;
+
+
+public class parse {
+    public static DecodedJWT deToken(final String token) {
+        DecodedJWT jwt = null;
+        try {
+            JWTVerifier verifier = JWT.require(getKey()).build();
+            jwt = verifier.verify(token);
+        } catch (JWTVerificationException exception) {
+            // Invalid signature/claims
+            return null;
+        }
+        return jwt;
+    }
+}

src/main/resources/plugin.json

@@ -0,0 +1,7 @@
+{
+  "name": "GCAuth_OAuth",
+  "description": "The in-game login system for Grasscutter is based on oauth and GCAuth.",
+  "version": "1.0.0",
+  "author": ["omg-xtao"],
+  "mainClass": "com.xtaolabs.gcauth_oauth.GCAuth_OAuth"
+}