├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── src ├── test │ ├── resources │ │ └── font │ │ │ └── ascii.png │ └── java │ │ └── dev │ │ └── cubxity │ │ └── mods │ │ └── obfchat │ │ └── gen │ │ └── ObfchatGenerator.java └── main │ ├── resources │ ├── obfchat-poc.mixins.json │ └── fabric.mod.json │ └── java │ └── dev │ └── cubxity │ └── mods │ └── obfchat │ ├── mixin │ └── network │ │ └── chat │ │ └── MixinPlayerChatMessage.java │ └── server │ └── ObfchatServer.java ├── run └── resourcepacks │ └── glyphs │ └── pack.mcmeta ├── settings.gradle ├── gradle.properties ├── LICENSE ├── README.md ├── .gitignore ├── gradlew.bat └── gradlew /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Cubxity/obfchat-poc/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /src/test/resources/font/ascii.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Cubxity/obfchat-poc/HEAD/src/test/resources/font/ascii.png -------------------------------------------------------------------------------- /run/resourcepacks/glyphs/pack.mcmeta: -------------------------------------------------------------------------------- 1 | { 2 | "pack": { 3 | "pack_format": 9, 4 | "description": "glyphs" 5 | } 6 | } -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | repositories { 3 | maven { 4 | name = 'Fabric' 5 | url = 'https://maven.fabricmc.net/' 6 | } 7 | gradlePluginPortal() 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /src/main/resources/obfchat-poc.mixins.json: -------------------------------------------------------------------------------- 1 | { 2 | "required": true, 3 | "minVersion": "0.8", 4 | "package": "dev.cubxity.mods.obfchat.mixin", 5 | "compatibilityLevel": "JAVA_17", 6 | "mixins": [ 7 | ], 8 | "client": [ 9 | ], 10 | "server": [ 11 | "network.chat.MixinPlayerChatMessage" 12 | ], 13 | "injectors": { 14 | "defaultRequire": 1 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Done to increase the memory available to gradle. 2 | org.gradle.jvmargs=-Xmx1G 3 | # Fabric Properties 4 | # check these on https://modmuss50.me/fabric.html 5 | minecraft_version=1.19.1-pre4 6 | yarn_mappings=1.19.1-pre4+build.2 7 | loader_version=0.14.8 8 | # Mod Properties 9 | mod_version=0.0.1 10 | maven_group=dev.cubxity.mods 11 | archives_base_name=obfchat-poc 12 | # Dependencies 13 | # check this on https://modmuss50.me/fabric.html 14 | fabric_version=0.57.2+1.19.1 15 | -------------------------------------------------------------------------------- /src/main/resources/fabric.mod.json: -------------------------------------------------------------------------------- 1 | { 2 | "schemaVersion": 1, 3 | "id": "obfchat-poc", 4 | "version": "${version}", 5 | "name": "ObfchatPoC", 6 | "description": "", 7 | "authors": [], 8 | "contact": {}, 9 | "license": "MIT", 10 | "environment": "server", 11 | "entrypoints": { 12 | "server": [ 13 | { 14 | "value": "dev.cubxity.mods.obfchat.server.ObfchatServer" 15 | } 16 | ] 17 | }, 18 | "mixins": [ 19 | "obfchat-poc.mixins.json" 20 | ], 21 | "depends": { 22 | "fabricloader": ">=0.14.8", 23 | "fabric": "*", 24 | "minecraft": "1.19.1-beta.4" 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/main/java/dev/cubxity/mods/obfchat/mixin/network/chat/MixinPlayerChatMessage.java: -------------------------------------------------------------------------------- 1 | package dev.cubxity.mods.obfchat.mixin.network.chat; 2 | 3 | import net.minecraft.network.FriendlyByteBuf; 4 | import net.minecraft.network.chat.PlayerChatMessage; 5 | import org.spongepowered.asm.mixin.Mixin; 6 | import org.spongepowered.asm.mixin.injection.At; 7 | import org.spongepowered.asm.mixin.injection.Inject; 8 | import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; 9 | 10 | import java.util.Optional; 11 | 12 | @Mixin(PlayerChatMessage.class) 13 | public abstract class MixinPlayerChatMessage { 14 | @Inject( 15 | method = "write", 16 | at = @At(value = "INVOKE", target = "Lnet/minecraft/network/FriendlyByteBuf;writeOptional(Ljava/util/Optional;Lnet/minecraft/network/FriendlyByteBuf$Writer;)V"), 17 | cancellable = true 18 | ) 19 | private void write(FriendlyByteBuf friendlyByteBuf, CallbackInfo ci) { 20 | friendlyByteBuf.writeOptional(Optional.empty(), FriendlyByteBuf::writeComponent); 21 | ci.cancel(); 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2022 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # obfchat-poc 2 | 3 | This PoC demonstrates how the chat can be obfuscated on the server, while remaining signed. 4 | This targets the Minecraft version 1.19.1-pre4. 5 | 6 | https://user-images.githubusercontent.com/27609129/178434755-2ff5efbe-9427-4a76-ba8a-13eb02ad29af.mp4 7 | 8 | *Do note that there will be a warning screen and a resource pack prompt, which were not shown in this video.* 9 | 10 | The idea was brought up to me by [Machine-Maker](https://github.com/Machine-Maker). 11 | 12 | ## Setting Up 13 | 14 | 1. Run [ObfchatGenerator](src/test/java/dev/cubxity/mods/obfchat/gen/ObfchatGenerator.java) 15 | 2. Set up a server with `previews-chat` set to true in serrver.properties and the mod installed 16 | 3. Ensure that `glyphs.json` is in the server's root directory (default: `run`) 17 | 4. Archive the resource pack in `run/resourcepacks/glyph` 18 | 5. Force the resource pack by setting `require-resource-pack` to true and by setting `resource-pack` to a URL with the 19 | resource pack. 20 | 6. Start the server and join the server 21 | 22 | ## Why? 23 | 24 | This shows how the server can obfuscate the chat using the decoration/preview feature. 25 | With help of a custom resource pack, the chat is shown normally to the users. 26 | 27 | However, in reality, the actual message (which is signed) is gibberish. 28 | Meaning, it will be nearly impossible to report those. 29 | 30 | Furthermore, a malicious server can potentially use this to make it look like a player is typing a legitimate message. 31 | For example, turning "love" into "hate" by using character mapping and resource pack. 32 | 33 | ## Potential Pitfalls 34 | 35 | * Any client that tries to get around the required resource pack will have unreadable chat 36 | * The server log is obfuscated, however this can be mitigated with a mod/plugin 37 | * This can potentially be mitigated by Mojang by figuring out the character mapping. A workaround for this would be to 38 | rotate the mapping periodically. Furthermore, the server can also assign each player to a specific unicode range. 39 | * The server can potentially be banned from the session server by Mojang -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # User-specific stuff 2 | .idea/ 3 | 4 | *.iml 5 | *.ipr 6 | *.iws 7 | 8 | # IntelliJ 9 | out/ 10 | # mpeltonen/sbt-idea plugin 11 | .idea_modules/ 12 | 13 | # JIRA plugin 14 | atlassian-ide-plugin.xml 15 | 16 | # Compiled class file 17 | *.class 18 | 19 | # Log file 20 | *.log 21 | 22 | # BlueJ files 23 | *.ctxt 24 | 25 | # Package Files # 26 | *.jar 27 | *.war 28 | *.nar 29 | *.ear 30 | *.zip 31 | *.tar.gz 32 | *.rar 33 | 34 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 35 | hs_err_pid* 36 | 37 | *~ 38 | 39 | # temporary files which can be created if a process still has a handle open of a deleted file 40 | .fuse_hidden* 41 | 42 | # KDE directory preferences 43 | .directory 44 | 45 | # Linux trash folder which might appear on any partition or disk 46 | .Trash-* 47 | 48 | # .nfs files are created when an open file is removed but is still being accessed 49 | .nfs* 50 | 51 | # General 52 | .DS_Store 53 | .AppleDouble 54 | .LSOverride 55 | 56 | # Icon must end with two \r 57 | Icon 58 | 59 | # Thumbnails 60 | ._* 61 | 62 | # Files that might appear in the root of a volume 63 | .DocumentRevisions-V100 64 | .fseventsd 65 | .Spotlight-V100 66 | .TemporaryItems 67 | .Trashes 68 | .VolumeIcon.icns 69 | .com.apple.timemachine.donotpresent 70 | 71 | # Directories potentially created on remote AFP share 72 | .AppleDB 73 | .AppleDesktop 74 | Network Trash Folder 75 | Temporary Items 76 | .apdisk 77 | 78 | # Windows thumbnail cache files 79 | Thumbs.db 80 | Thumbs.db:encryptable 81 | ehthumbs.db 82 | ehthumbs_vista.db 83 | 84 | # Dump file 85 | *.stackdump 86 | 87 | # Folder config file 88 | [Dd]esktop.ini 89 | 90 | # Recycle Bin used on file shares 91 | $RECYCLE.BIN/ 92 | 93 | # Windows Installer files 94 | *.cab 95 | *.msi 96 | *.msix 97 | *.msm 98 | *.msp 99 | 100 | # Windows shortcuts 101 | *.lnk 102 | 103 | .gradle 104 | build/ 105 | 106 | # Ignore Gradle GUI config 107 | gradle-app.setting 108 | 109 | # Cache of project 110 | .gradletasknamecache 111 | 112 | **/build/ 113 | 114 | # Common working directory 115 | run/* 116 | 117 | !run/resourcepacks 118 | run/resourcepacks/glyphs/* 119 | !run/resourcepacks/glyphs/pack.mcmeta 120 | 121 | # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) 122 | !gradle-wrapper.jar 123 | 124 | /gen 125 | -------------------------------------------------------------------------------- /src/main/java/dev/cubxity/mods/obfchat/server/ObfchatServer.java: -------------------------------------------------------------------------------- 1 | package dev.cubxity.mods.obfchat.server; 2 | 3 | import com.google.gson.Gson; 4 | import com.google.gson.JsonObject; 5 | import net.fabricmc.api.DedicatedServerModInitializer; 6 | import net.fabricmc.fabric.api.message.v1.ServerMessageDecoratorEvent; 7 | import net.minecraft.network.chat.Component; 8 | import net.minecraft.network.chat.MutableComponent; 9 | import net.minecraft.network.chat.contents.LiteralContents; 10 | 11 | import java.io.IOException; 12 | import java.nio.file.Files; 13 | import java.nio.file.Path; 14 | import java.util.concurrent.CompletableFuture; 15 | 16 | public class ObfchatServer implements DedicatedServerModInitializer { 17 | private final Gson gson = new Gson(); 18 | 19 | @Override 20 | public void onInitializeServer() { 21 | try { 22 | var json = Files.readString(Path.of("glyphs.json")); 23 | var glyphs = gson.fromJson(json, JsonObject.class); 24 | var offset = glyphs.get("offset").getAsInt(); 25 | var array = glyphs.getAsJsonArray("glyphs"); 26 | var map = new int[256]; 27 | for (int i = 0; i < 255; i++) { 28 | map[i] = array.get(i).getAsInt() + offset; 29 | } 30 | 31 | ServerMessageDecoratorEvent.EVENT.register((serverPlayer, component) -> 32 | CompletableFuture.completedFuture(modify(component, map))); 33 | } catch (IOException e) { 34 | e.printStackTrace(); 35 | } 36 | } 37 | 38 | private MutableComponent modify(Component component, int[] map) { 39 | var contents = component.getContents(); 40 | if (contents instanceof LiteralContents literal) { 41 | var builder = new StringBuilder(); 42 | literal.text().codePoints().forEach(codePoint -> { 43 | if (codePoint > 255 || codePoint == 32) { 44 | builder.appendCodePoint(codePoint); 45 | } else { 46 | builder.appendCodePoint(map[codePoint]); 47 | } 48 | }); 49 | contents = new LiteralContents(builder.toString()); 50 | } 51 | 52 | var newComponent = MutableComponent.create(contents); 53 | newComponent.setStyle(component.getStyle()); 54 | 55 | for (var sibling : component.getSiblings()) { 56 | newComponent.append(modify(sibling, map)); 57 | } 58 | 59 | return newComponent; 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /src/test/java/dev/cubxity/mods/obfchat/gen/ObfchatGenerator.java: -------------------------------------------------------------------------------- 1 | package dev.cubxity.mods.obfchat.gen; 2 | 3 | import com.google.gson.JsonArray; 4 | import com.google.gson.JsonObject; 5 | 6 | import javax.imageio.ImageIO; 7 | import java.awt.image.BufferedImage; 8 | import java.io.File; 9 | import java.io.IOException; 10 | import java.nio.file.Files; 11 | import java.nio.file.Path; 12 | import java.util.ArrayList; 13 | import java.util.Collections; 14 | import java.util.stream.IntStream; 15 | 16 | public class ObfchatGenerator { 17 | // This is the unicode code point to start at. This will occupy 256 proceeding codepoints. 18 | private static final int START_CODE_POINT = 0x4c * 256; 19 | 20 | public static void main(String[] args) throws IOException { 21 | var source = ImageIO.read(ObfchatGenerator.class.getResourceAsStream("/font/ascii.png")); 22 | var dest = new BufferedImage(128, 128, BufferedImage.TYPE_INT_ARGB); 23 | var graphics = dest.getGraphics(); 24 | 25 | // Shuffle the glyphs 26 | var map = new ArrayList<>(IntStream.range(0, 256).boxed().toList()); 27 | Collections.shuffle(map); 28 | 29 | // Map the glyphs to random places as defined above 30 | for (var sourceIndex = 0; sourceIndex < 256; sourceIndex++) { 31 | var sourceX = (sourceIndex % 16) * 8; 32 | var sourceY = (Math.floorDiv(sourceIndex, 16)) * 8; 33 | 34 | var destIndex = map.get(sourceIndex); 35 | var destX = (destIndex % 16) * 8; 36 | var destY = (Math.floorDiv(destIndex, 16)) * 8; 37 | 38 | var data = source.getSubimage(sourceX, sourceY, 8, 8); 39 | graphics.drawImage(data, destX, destY, null); 40 | } 41 | 42 | // Export glyphs and data 43 | var fontTextureDir = new File("run/resourcepacks/glyphs/assets/minecraft/textures/font/"); 44 | fontTextureDir.mkdirs(); 45 | ImageIO.write(dest, "PNG", new File(fontTextureDir, "glyphs.png")); 46 | 47 | var fontProvider = new JsonObject(); 48 | fontProvider.addProperty("type", "bitmap"); 49 | fontProvider.addProperty("file", "minecraft:font/glyphs.png"); 50 | fontProvider.addProperty("ascent", 7); 51 | 52 | var fontProviderChars = new JsonArray(); 53 | for (var row = 0; row < 16; row++) { 54 | var chars = new StringBuilder(); 55 | for (var col = 0; col < 16; col++) { 56 | var index = row * 16 + col; 57 | chars.append(String.format("\\u%04X", START_CODE_POINT + index)); 58 | } 59 | fontProviderChars.add(chars.toString()); 60 | } 61 | fontProvider.add("chars", fontProviderChars); 62 | 63 | var fontProviders = new JsonArray(); 64 | fontProviders.add(fontProvider); 65 | 66 | var fontJson = new JsonObject(); 67 | fontJson.add("providers", fontProviders); 68 | 69 | var fontDir = Path.of("run/resourcepacks/glyphs/assets/minecraft/font/"); 70 | Files.createDirectories(fontDir); 71 | 72 | // FIXME: is there a better way to do this? 73 | Files.writeString(fontDir.resolve("default.json"), fontJson.toString().replace("\\\\", "\\")); 74 | 75 | 76 | var glyphs = new JsonObject(); 77 | glyphs.addProperty("offset", START_CODE_POINT); 78 | 79 | var glyphsMap = new JsonArray(); 80 | for (int i : map) { 81 | glyphsMap.add(i); 82 | } 83 | glyphs.add("glyphs", glyphsMap); 84 | 85 | var runDir = Path.of("run"); 86 | Files.createDirectories(runDir); 87 | Files.writeString(runDir.resolve("glyphs.json"), glyphs.toString()); 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 84 | 85 | APP_NAME="Gradle" 86 | APP_BASE_NAME=${0##*/} 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | MAX_FD=$( ulimit -H -n ) || 147 | warn "Could not query maximum file descriptor limit" 148 | esac 149 | case $MAX_FD in #( 150 | '' | soft) :;; #( 151 | *) 152 | ulimit -n "$MAX_FD" || 153 | warn "Could not set maximum file descriptor limit to $MAX_FD" 154 | esac 155 | fi 156 | 157 | # Collect all arguments for the java command, stacking in reverse order: 158 | # * args from the command line 159 | # * the main class name 160 | # * -classpath 161 | # * -D...appname settings 162 | # * --module-path (only if needed) 163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 164 | 165 | # For Cygwin or MSYS, switch paths to Windows format before running java 166 | if "$cygwin" || "$msys" ; then 167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 169 | 170 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 171 | 172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 173 | for arg do 174 | if 175 | case $arg in #( 176 | -*) false ;; # don't mess with options #( 177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 178 | [ -e "$t" ] ;; #( 179 | *) false ;; 180 | esac 181 | then 182 | arg=$( cygpath --path --ignore --mixed "$arg" ) 183 | fi 184 | # Roll the args list around exactly as many times as the number of 185 | # args, so each arg winds up back in the position where it started, but 186 | # possibly modified. 187 | # 188 | # NB: a `for` loop captures its iteration list before it begins, so 189 | # changing the positional parameters here affects neither the number of 190 | # iterations, nor the values presented in `arg`. 191 | shift # remove old arg 192 | set -- "$@" "$arg" # push replacement arg 193 | done 194 | fi 195 | 196 | # Collect all arguments for the java command; 197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 198 | # shell script including quotes and variable substitutions, so put them in 199 | # double quotes to make sure that they get re-expanded; and 200 | # * put everything else in single quotes, so that it's not re-expanded. 201 | 202 | set -- \ 203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 204 | -classpath "$CLASSPATH" \ 205 | org.gradle.wrapper.GradleWrapperMain \ 206 | "$@" 207 | 208 | # Use "xargs" to parse quoted args. 209 | # 210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 211 | # 212 | # In Bash we could simply go: 213 | # 214 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 215 | # set -- "${ARGS[@]}" "$@" 216 | # 217 | # but POSIX shell has neither arrays nor command substitution, so instead we 218 | # post-process each arg (as a line of input to sed) to backslash-escape any 219 | # character that might be a shell metacharacter, then use eval to reverse 220 | # that process (while maintaining the separation between arguments), and wrap 221 | # the whole thing up as a single "set" statement. 222 | # 223 | # This will of course break if any of these variables contains a newline or 224 | # an unmatched quote. 225 | # 226 | 227 | eval "set -- $( 228 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 229 | xargs -n1 | 230 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 231 | tr '\n' ' ' 232 | )" '"$@"' 233 | 234 | exec "$JAVACMD" "$@" 235 | --------------------------------------------------------------------------------