commit 4a35feecc0340f6afd16c4d49343a6d0e5d15a18 Author: hypherionmc Date: Thu Apr 4 00:31:42 2024 +0200 Initial Commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..de13221 --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### IntelliJ IDEA ### +.idea/modules.xml +.idea/jarRepositories.xml +.idea/compiler.xml +.idea/libraries/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store +.idea \ No newline at end of file diff --git a/HEADER b/HEADER new file mode 100644 index 0000000..a8a2920 --- /dev/null +++ b/HEADER @@ -0,0 +1,6 @@ +/* + * This file is part of KeyMaster, licensed under the MIT License (MIT). + * + * Copyright (c) $YEAR HypherionSA and Contributors + * + */ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cd3ef08 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 HypherionSA and Contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..1aabf3a --- /dev/null +++ b/build.gradle @@ -0,0 +1,90 @@ +plugins { + id 'java' + id 'idea' + id 'java-gradle-plugin' + id 'com.gradle.plugin-publish' version '1.2.1' + id 'com.diffplug.spotless' version '6.13.0' + id 'com.github.johnrengelman.shadow' version '8.1.1' +} +apply plugin: 'maven-publish' + +group = 'dev.firstdark.keymaster' +version = "${version_major}.${version_minor}.${version_patch}" +description = "Gradle plugin to Sign Jars" +archivesBaseName = 'KeyMaster' +java.toolchain.languageVersion = JavaLanguageVersion.of(8) + +if (System.getenv('BUILD_NUMBER') != null) { + var build = (System.getenv('BUILD_NUMBER').toInteger() - 1) + version = "${version_major}.${version_minor}.${build}" +} + +configurations { + shadeMe + implementation.extendsFrom shadeMe +} + +repositories { + mavenCentral() +} + +dependencies { + implementation gradleApi() + + shadeMe "org.apache.commons:commons-lang3:${commons_lang}" + + compileOnly "org.projectlombok:lombok:${lombok}" + annotationProcessor "org.projectlombok:lombok:${lombok}" +} + +gradlePlugin { + plugins { + keyMasterGradlePlugin { + id = "dev.firstdark.keymaster" + description = project.description + displayName = "KeyMaster" + version = project.version + implementationClass = "dev.firstdark.keymaster.plugin.KeyMasterGradlePlugin" + tags.set(['verification', 'signing', 'gradle', 'security']) + } + } +} + +shadowJar { + duplicatesStrategy = DuplicatesStrategy.EXCLUDE + configurations = [project.configurations.getByName("shadeMe")] + archiveClassifier.set(null) +} + +jar { + manifest { + attributes([ + 'Timestamp' : System.currentTimeMillis(), + 'Specification-Title' : project.archivesBaseName, + 'Specification-Version' : project.version, + 'Implementation-Title' : project.archivesBaseName, + 'Implementation-Version' : project.version, + 'Implementation-Timestamp': new Date().format("yyyy-MM-dd'T'HH:mm:ssZ"), + 'Built-On-Java' : "${System.getProperty('java.vm.version')} (${System.getProperty('java.vm.vendor')})" + ]) + } +} + +spotless { + java { + targetExclude("src/test/**") + licenseHeaderFile(rootProject.file("HEADER")).yearSeparator("-") + } +} + +publishing { + repositories { + maven { + url System.getenv('MAVEN_URL') + credentials { + username System.getenv('MAVEN_USER') + password System.getenv('MAVEN_PASS') + } + } + } +} \ No newline at end of file diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..abbaea7 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,7 @@ +version_major=1 +version_minor=0 +version_patch=0 + +# Dependencies +lombok=1.18.30 +commons_lang=3.14.0 \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..927f14d --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Wed Apr 03 21:26:42 SAST 2024 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/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" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/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 diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..08c1df8 --- /dev/null +++ b/readme.md @@ -0,0 +1,170 @@ +## KeyMaster + +A Simple Gradle plugin to help you sign your jars. + +*** + +### Getting Started + +To get started, you will need keystore. If you already have this, you can skip this part. + +In a terminal, or in command line, run the following command: + +```bash +keytool -genkey -alias YOUR_ALIAS_HERE -keyalg RSA -keysize 2048 -keystore keystore.jks +``` + +Answer the required questions, and your file will be generated once completed. + +Copy this file to a safe directory, somewhere you can access it easily. KEEP IT OUT OF YOUR GIT REPO + +### Installing the plugin + +
Groovy DSL +To use this plugin inside your project, first you have to add our maven. + +To do this, open up `settings.gradle` and add the following: + +```groovy +pluginManagement { + repositories { + gradlePluginPortal() + maven { + url "https://maven.firstdark.dev/releases" + } + } +} +``` + +Next, in your `build.gradle` add: + +![badge](https://maven.firstdarkdev.xyz/api/badge/latest/releases/dev/firstdark/keymaster?color=40c14a&name=keymaster) + +```groovy +plugins { + id "dev.firstdark.keymaster" version "VERSION" +} +``` + +Replace VERSION with the version above. + +Finally, add the following to `build.gradle` file: + +```groovy +import dev.firstdark.keymaster.tasks.SignJarTask + +// Register a custom task to sign your jar +tasks.register('signJar', SignJarTask) { + // Depend on the task used to build your project + dependsOn jar + + // The input artifact. This can be a Task, File or File Name + artifactInput = jar + + // Optional. Set the output name of the signed jar. This defaults to the artifactInput file name, and will overwrite it + outputFileName = "testsign" + + // The password of your key + keyPass = "123456" + + // Your key alias + keyStoreAlias = "testalias" + + // Your keystore password + keyStorePass = "123456" + + // Your keystore location + keyStore = "/home/hypherionsa/dummystore.jks" +} + +// Example of signing another jar +tasks.register('signDummyJar', SignJarTask) { + dependsOn createDummyJar + artifactInput = createDummyJar + + keyPass = "123456" + keyStoreAlias = "testalias" + keyStorePass = "123456" + keyStore = "/home/hypherionsa/dummystore.jks" +} +``` + +That's all there is to it. You can use this custom task as an input for maven publishing, [modpublisher](https://github.com/firstdarkdev/modpublisher) or any other task that takes in a file +
+ +
Kotlin DSL +To use this plugin inside your project, first you have to add our maven. + +To do this, open up `settings.gradle.kts` and add the following: + +```kotlin +pluginManagement { + repositories { + gradlePluginPortal() + maven { + url = uri("https://maven.firstdark.dev/releases") + } + } +} +``` + +Next, in your `build.gradle.kts` add: + +![badge](https://maven.firstdarkdev.xyz/api/badge/latest/releases/dev/firstdark/keymaster?color=40c14a&name=keymaster) + +```kotlin +plugins { + id("com.hypherionmc.modutils.modpublisher") version "VERSION" +} +``` + +Replace VERSION with the version above. + +Finally, add the following to `build.gradle.kts` file: + +```kotlin +import dev.firstdark.keymaster.tasks.SignJarTask +import org.gradle.kotlin.dsl.register + +// Register a custom task to sign your jar +val signJar by tasks.register("signJar") { + // Depend on the task used to build your project + dependsOn(tasks.jar) + + // The input artifact. This can be a Task, File or File Name + artifactInput = tasks.jar + + // Optional. Set the output name of the signed jar. This defaults to the artifactInput file name, and will overwrite it + outputFileName = "testsign" + + // The password of your key + keyPass = "123456" + + // Your key alias + keyStoreAlias = "testalias" + + // Your keystore password + keyStorePass = "123456" + + // Your keystore location + keyStore = "/home/hypherionsa/dummystore.jks" +} + +// Example of signing another jar +val signDummyJar by tasks.register("signDummyJar") { + dependsOn(tasks.createDummyJar) + artifactInput = tasks.createDummyJar + + keyPass = "123456" + keyStoreAlias = "testalias" + keyStorePass = "123456" + keyStore = "/home/hypherionsa/dummystore.jks" +} +``` + +That's all there is to it. You can use this custom task as an input for maven publishing, [modpublisher](https://github.com/firstdarkdev/modpublisher) or any other task that takes in a file +
+ +*** + +If you need any other help, open an issue, or visit us on [Discord](https://discord.firstdark.dev) \ No newline at end of file diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..5daf30e --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'keymaster' \ No newline at end of file diff --git a/src/main/java/dev/firstdark/keymaster/plugin/KeyMasterGradlePlugin.java b/src/main/java/dev/firstdark/keymaster/plugin/KeyMasterGradlePlugin.java new file mode 100644 index 0000000..7d2637f --- /dev/null +++ b/src/main/java/dev/firstdark/keymaster/plugin/KeyMasterGradlePlugin.java @@ -0,0 +1,17 @@ +package dev.firstdark.keymaster.plugin; + +import org.gradle.api.Plugin; +import org.gradle.api.Project; +import org.jetbrains.annotations.NotNull; + +/** + * @author HypherionSA + * Main plugin class. Mostly a dummy for this plugin + */ +public class KeyMasterGradlePlugin implements Plugin { + + @Override + public void apply(@NotNull Project target) { + target.getLogger().info("KeyMaster Plugin is activated"); + } +} diff --git a/src/main/java/dev/firstdark/keymaster/tasks/SignJarTask.java b/src/main/java/dev/firstdark/keymaster/tasks/SignJarTask.java new file mode 100644 index 0000000..0594252 --- /dev/null +++ b/src/main/java/dev/firstdark/keymaster/tasks/SignJarTask.java @@ -0,0 +1,199 @@ +package dev.firstdark.keymaster.tasks; + +import lombok.Setter; +import org.apache.commons.lang3.StringUtils; +import org.gradle.api.Project; +import org.gradle.api.provider.Provider; +import org.gradle.api.tasks.Input; +import org.gradle.api.tasks.OutputFile; +import org.gradle.api.tasks.TaskAction; +import org.gradle.api.tasks.bundling.AbstractArchiveTask; +import org.gradle.jvm.tasks.Jar; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.StandardCopyOption; +import java.util.HashMap; +import java.util.Map; + +/** + * @author HypherionSA + * Main Sign Task. Can be configured per jar + */ +@Setter +public class SignJarTask extends Jar { + + // Input task, file or file name to sign + private Object artifactInput; + + // Output file name. Defaults to input file + private String outputFileName = "signed.jar"; + + // KeyStore values + private String keyStorePass; + private String keyStore; + private String keyStoreAlias; + private String keyPass; + + // Set the output directory. Defaults to build/libs + private String outputDirectory = getProject().getBuildDir() + "/libs"; + + @Input + public Object getArtifactInput() { + return resolveFile(getProject(), this.artifactInput); + } + + @Input + public String getOutputFileName() { + return this.outputFileName; + } + + @Input + public String getKeyStorePass() { + return this.keyStorePass; + } + + @Input + public String getKeyStore() { + return this.keyStore; + } + + @Input + public String getKeyStoreAlias() { + return this.keyStoreAlias; + } + + @Input + public String getKeyPass() { + return this.keyPass; + } + + @Input + public String getOutputDirectory() { + return this.outputDirectory; + } + + @OutputFile + public File getOutputFile() { + return new File(outputDirectory, outputFileName); + } + + /** + * Main Task Logic + */ + @SuppressWarnings("ResultOfMethodCallIgnored") + @TaskAction + public void doTask() { + // Check that input is supplied + if (artifactInput == null) { + getProject().getLogger().error("Input cannot be null!"); + return; + } + + // Check that all the required values are supplied + if (isNullOrBlank(keyPass) || isNullOrBlank(keyStore) || isNullOrBlank(keyStoreAlias) || isNullOrBlank(keyStorePass)) { + getLogger().error("Please provide all required parameters: keyStore, keyStoreAlias, keyStorePass, keyPass"); + return; + } + + // Create temporary directory for working + File tempDir = new File(getProject().getBuildDir(), "signing"); + tempDir.mkdirs(); + + try { + processArtifact(artifactInput, tempDir); + } catch (Exception e) { + getLogger().error("Failed to sign artifact {}", artifactInput, e); + } + + // Remove the temp working dir + tempDir.delete(); + } + + /** + * Jar Signing logic. This creates the temporary files, signs it, and copies it to where it should be + * @param input Input task, file or file name to process + * @param tempDir The temporary working directory + * @throws IOException This is mostly thrown when a file copy error occurs + */ + @SuppressWarnings("ResultOfMethodCallIgnored") + private void processArtifact(Object input, File tempDir) throws IOException { + // Set up the input file + File inputFile = resolveFile(getProject(), input); + + // Check if the output file is specified. If not, default to the input file + outputFileName = outputFileName.equalsIgnoreCase("signed.jar") ? inputFile.getName() : outputFileName + ".jar"; + + // Copy the original input file to the temporary processing folder + File tempInput = new File(tempDir, inputFile.getName()); + Files.copy(inputFile.toPath(), tempInput.toPath(), StandardCopyOption.REPLACE_EXISTING); + + // Create a temporary output jar + File tempOutput = new File(tempDir, outputFileName); + + // Configure the jar signing + Map map = new HashMap<>(); + map.put("alias", keyStoreAlias); + map.put("storePass", keyStorePass); + map.put("jar", tempInput.getAbsolutePath()); + map.put("signedJar", tempOutput.getAbsolutePath()); + map.put("keypass", keyPass); + map.put("keyStore", resolveFile(getProject(), keyStore).getAbsolutePath()); + + // SIGN IT + getProject().getAnt().invokeMethod("signjar", map); + + // Copy the signed jar to the libs folder + Files.copy(tempOutput.toPath(), getOutputFile().toPath(), StandardCopyOption.REPLACE_EXISTING); + + getProject().getLogger().lifecycle("Signed " + getOutputFile().getName() + " successfully"); + + // Cleanup the temporary files + tempOutput.delete(); + tempInput.delete(); + } + + /** + * Helper method to check if a supplied string is null or empty + * @param s The string to test + * @return True if null or empty + */ + private boolean isNullOrBlank(String s) { + if (s == null) + return true; + + return StringUtils.isBlank(s); + } + + /** + * Resolve an Object to a File + * @param project The project the file potentially belongs to + * @param obj The object to process + * @return A File object, ready to use + */ + private File resolveFile(Project project, Object obj) { + if (obj == null) { + throw new NullPointerException("Null Path"); + } + + if (obj instanceof Provider) { + Provider p = (Provider) obj; + obj = p.get(); + } + + if (obj instanceof File) { + return (File) obj; + } + + if (obj instanceof AbstractArchiveTask) { + return ((AbstractArchiveTask)obj).getArchiveFile().get().getAsFile(); + } + + if (obj instanceof String) { + return new File(obj.toString()); + } + + return project.file(obj); + } +} diff --git a/testproject/build.gradle b/testproject/build.gradle new file mode 100644 index 0000000..cc747d8 --- /dev/null +++ b/testproject/build.gradle @@ -0,0 +1,58 @@ +import dev.firstdark.keymaster.tasks.SignJarTask + +plugins { + id 'java' + id "dev.firstdark.keymaster" +} + +group = 'dev.firstdark.keymastertest' +version = '1.0.0' + +repositories { + mavenCentral() +} + +dependencies { + +} + +tasks.register('createDummyJar', Jar) { + // Configure the JAR task to have no files + from {} + archiveFileName = 'dummy.jar' // Set the desired name for the JAR file +} + +// Register a custom task to sign your jar +tasks.register('signJar', SignJarTask) { + // Depend on the task used to build your project + dependsOn jar + + // The input artifact. This can be a Task, File or File Name + artifactInput = jar + + // Optional. Set the output name of the signed jar. This defaults to the artifactInput file name, and will overwrite it + outputFileName = "testsign" + + // The password of your key + keyPass = "123456" + + // Your key alias + keyStoreAlias = "testalias" + + // Your keystore password + keyStorePass = "123456" + + // Your keystore location + keyStore = "/home/hypherionsa/dummystore.jks" +} + +// Example of signing another jar +tasks.register('signDummyJar', SignJarTask) { + dependsOn createDummyJar + artifactInput = createDummyJar + + keyPass = "123456" + keyStoreAlias = "testalias" + keyStorePass = "123456" + keyStore = "/home/hypherionsa/dummystore.jks" +} diff --git a/testproject/dummystore.jks b/testproject/dummystore.jks new file mode 100644 index 0000000..6b05555 Binary files /dev/null and b/testproject/dummystore.jks differ diff --git a/testproject/gradle/wrapper/gradle-wrapper.jar b/testproject/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/testproject/gradle/wrapper/gradle-wrapper.jar differ diff --git a/testproject/gradle/wrapper/gradle-wrapper.properties b/testproject/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..927f14d --- /dev/null +++ b/testproject/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Wed Apr 03 21:26:42 SAST 2024 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/testproject/gradlew b/testproject/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/testproject/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" "$@" diff --git a/testproject/gradlew.bat b/testproject/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/testproject/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 diff --git a/testproject/settings.gradle b/testproject/settings.gradle new file mode 100644 index 0000000..00dc717 --- /dev/null +++ b/testproject/settings.gradle @@ -0,0 +1,3 @@ +rootProject.name = 'testproject' + +includeBuild("../") \ No newline at end of file diff --git a/testproject/src/main/java/dev/firstdark/keymaster/Main.java b/testproject/src/main/java/dev/firstdark/keymaster/Main.java new file mode 100644 index 0000000..91a9e28 --- /dev/null +++ b/testproject/src/main/java/dev/firstdark/keymaster/Main.java @@ -0,0 +1,7 @@ +package dev.firstdark.keymaster; + +public class Main { + public static void main(String[] args) { + System.out.println("Hello world!"); + } +} \ No newline at end of file