diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a39cab4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: Bug report about: Create a report to help us improve title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] + +**Smartphone (please complete the following information):** + +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..5fe926b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature request about: Suggest an idea for this project title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml new file mode 100644 index 0000000..c690666 --- /dev/null +++ b/.github/workflows/greetings.yml @@ -0,0 +1,13 @@ +name: Greetings + +on: [ pull_request, issues ] + +jobs: + greeting: + runs-on: ubuntu-latest + steps: + - uses: actions/first-interaction@v1 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + issue-message: 'Welcome and thanks for contributing! Make sure to leave a detailed explanation of the issue.' + pr-message: 'Welcome and thanks for contributing! Make sure to follow the project''s coding conventions.' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2d6b1b2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,28 @@ +# IDE +*.iml +*.ipr +*.iws +**/.idea/workspace.xml +**/.idea/tasks.xml +**/.idea/misc.xml +**/.idea/modules.xml +**/.idea/gradle.xml +**/.idea/runConfigurations.xml +**/.idea/assetWizardSettings.xml +**/.idea/datasources.xml +**/.idea/dataSources.ids +**/.idea/shelf +**/.idea/libraries +**/.idea/fileTemplates +**/.idea/dictionaries +**/.idea/caches +local.properties +/captures +.externalNativeBuild + +# Gradle +.gradle +build/ + +# Mac +.DS_Store diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + http://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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2cce516 --- /dev/null +++ b/README.md @@ -0,0 +1,120 @@ +# redacted + +Components to redact sensitive information from `toString` output.
+GitHub tag (latest by date) + +This library was inspired by +this [article](https://mustafaali.net/2018/01/14/Kotlin-data-classes-and-sensitive-information/) that I was introduced +to by a coworker. I often find myself needing this functionality in projects, so I decided to advance the functionality +and make it a reusable library. + +```kotlin +data class Credentials( + val email: String, + val password: RedactedProperty +) + +val credentials = Credentials( + email = "test@example.com", + password = RedactedProperty(value = "jhdgldfi248nd!39d?") +) +``` + +## Using the library + +Simply use the `RedactedProperty` in place of any property that contains sensitive information that should not be +printed out. + +```kotlin +data class Credentials( + val email: String, + val password: RedactedProperty +) +``` + +To obtain an instance of a `RedactedProperty`, just use the constructor: + +```kotlin +RedactedProperty(value = "jhdgldfi248nd!39d?") +``` + +To override the default value that is printed when `toString` is called on the `RedactedProperty`, provide +the `redactedString` value: + +```kotlin +RedactedProperty( + value = "jhdgldfi248nd!39d?", + redactedString = "******" +) +``` + +To specify an amount of times the `redactedString` value should be repeated when the `toString` function is called, +provide the `repeatCount` value (which defaults to `RepeatCount.Exact(count = 1)`): + +```kotlin +RedactedProperty( + value = "jhdgldfi248nd!39d?", + redactedString = "*", + repeatCount = RepeatCount.MatchLength +) + +RedactedProperty( + value = "jhdgldfi248nd!39d?", + redactedString = "*", + repeatCount = RepeatCount.Exact(count = 5) +) +``` + +**Note:** that the redacted property can still be printed out and obtained if explicitly calling the `toString` function +on the `RedactedProperty.value` property. + +## Building the library + +The library is provided through [Repsy.io](https://repsy.io). Checkout +the [releases page](https://github.com/chRyNaN/redacted/releases) to get the latest version.
+GitHub tag (latest by date) + +### Repository + +```groovy +repositories { + maven { url = "https://repo.repsy.io/mvn/chrynan/public" } +} +``` + +### Dependencies + +**Core:** + +```groovy +implementation "com.chrynan.redacted:redacted-core:VERSION" +``` + +**Serialization:** + +```groovy +implementation "com.chrynan.redacted:redacted-serialization:VERSION" +``` + +## Documentation + +More detailed documentation is available in the [docs](docs) folder. The entry point to the documentation can be +found [here](docs/index.md). + +## License + +``` +Copyright 2021 chRyNaN + +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 + + http://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. +``` diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..a8e2b68 --- /dev/null +++ b/build.gradle @@ -0,0 +1,41 @@ +import com.chrynan.redacted.buildSrc.LibraryConstants + +group LibraryConstants.group +version LibraryConstants.versionName + +buildscript { + repositories { + google() + jcenter() + maven { url = "https://repo.repsy.io/mvn/chrynan/public" } + maven { url = "https://dl.bintray.com/chrynan/chrynan" } + } + dependencies { + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.31" + classpath "org.jetbrains.dokka:dokka-gradle-plugin:1.4.30" + classpath "org.jetbrains.kotlin:kotlin-serialization:1.4.31" + classpath "com.chrynan.target:target-plugin:0.1.0" + } +} + +apply plugin: "org.jetbrains.dokka" + +allprojects { + repositories { + google() + jcenter() + mavenCentral() + maven { url = "https://jitpack.io" } + maven { url = "https://dl.bintray.com/chrynan/chrynan" } + maven { url = "https://repo.repsy.io/mvn/chrynan/public" } + } +} + +task clean(type: Delete) { + delete rootProject.buildDir +} + +// Documentation +tasks.dokkaGfmMultiModule.configure { + outputDirectory.set(file("${projectDir.path}/docs")) +} diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts new file mode 100644 index 0000000..3d7a954 --- /dev/null +++ b/buildSrc/build.gradle.kts @@ -0,0 +1,7 @@ +plugins { + `kotlin-dsl` +} + +repositories { + jcenter() +} diff --git a/buildSrc/src/main/java/com.chrynan.redacted.buildSrc/LibraryConstants.kt b/buildSrc/src/main/java/com.chrynan.redacted.buildSrc/LibraryConstants.kt new file mode 100644 index 0000000..46fb8f7 --- /dev/null +++ b/buildSrc/src/main/java/com.chrynan.redacted.buildSrc/LibraryConstants.kt @@ -0,0 +1,14 @@ +package com.chrynan.redacted.buildSrc + +object LibraryConstants { + + const val bintrayRepo = "chrynan" + const val group = "com.chrynan.redacted" + const val owner = "chrynan" + const val repoName = "redacted" + const val versionName = "0.1.0" + const val versionCode = 1 + const val versionDescription = "Release 0.1.0" + const val license = "Apache-2.0" + const val vcsUrl = "https://github.com/chRyNaN/redacted.git" +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..63dfa1b --- /dev/null +++ b/gradle.properties @@ -0,0 +1,6 @@ +kotlin.code.style=official +kotlin.native.distribution.type=prebuilt +kotlin.mpp.enableGranularSourceSetsMetadata=true +kotlin.native.enableDependencyPropagation=false +systemProp.org.gradle.internal.publish.checksums.insecure=true +android.useAndroidX=true diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e708b1c 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..be52383 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..4f906e0 --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or 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 UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$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 "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# 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 + ;; + 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" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..ac1b06f --- /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/redacted-core/Module.md b/redacted-core/Module.md new file mode 100644 index 0000000..b062603 --- /dev/null +++ b/redacted-core/Module.md @@ -0,0 +1,3 @@ +# Module redacted-core + +Core redacted components, such as, `RedactedProperty`. diff --git a/redacted-core/build.gradle b/redacted-core/build.gradle new file mode 100644 index 0000000..37fa5ae --- /dev/null +++ b/redacted-core/build.gradle @@ -0,0 +1,68 @@ +import com.chrynan.redacted.buildSrc.LibraryConstants + +apply plugin: "kotlin-multiplatform" +apply plugin: "maven-publish" +apply plugin: "org.jetbrains.dokka" +apply plugin: "com.chrynan.target.plugin" + +group LibraryConstants.group +version LibraryConstants.versionName + +kotlin { + targets { + jvm() + js() + ios() + } + sourceSets { + all { + languageSettings { + languageSettings.enableLanguageFeature("InlineClasses") + } + } + commonMain { + dependencies { + implementation "org.jetbrains.kotlin:kotlin-stdlib-common" + } + } + } +} + +configurations { + compileClasspath +} + +tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).all { + kotlinOptions { + jvmTarget = "1.8" + } +} + +publishing { + repositories { + maven { + url "https://repo.repsy.io/mvn/chrynan/public" + + credentials { + username = project.findProperty("repsyUsername") ?: System.getenv("repsyUsername") + password = project.findProperty("repsyToken") ?: System.getenv("repsyToken") + } + } + } +} + +// Target Information +kotlinTargetDataGenerator { + generateJson = true + generateSvg = true + outputPath = "${projectDir.path}/targets" +} + +// Documentation +tasks.named("dokkaGfm") { + dokkaSourceSets { + configureEach { + includes.from("Module.md") + } + } +} diff --git a/redacted-core/src/commonMain/kotlin/com.chrynan.redacted.core/RedactedProperty.kt b/redacted-core/src/commonMain/kotlin/com.chrynan.redacted.core/RedactedProperty.kt new file mode 100644 index 0000000..7ccee40 --- /dev/null +++ b/redacted-core/src/commonMain/kotlin/com.chrynan.redacted.core/RedactedProperty.kt @@ -0,0 +1,43 @@ +@file:Suppress("unused") + +package com.chrynan.redacted.core + +/** + * A wrapper class for any type that needs to be redacted when calling [toString] so that it doesn't output sensitive + * data. + */ +class RedactedProperty( + val value: T, + private val redactedString: String = "█████████", + private val repeatCount: RepeatCount = RepeatCount.Exact(count = 1) +) { + + override fun equals(other: Any?): Boolean { + if (other !is RedactedProperty<*>) return false + + return value == other.value + } + + override fun hashCode(): Int = value.hashCode() + + override fun toString(): String = buildString { + when (repeatCount) { + is RepeatCount.Exact -> { + if (repeatCount.count <= 0) { + append("") + } else { + for (i in 0 until repeatCount.count) { + append(redactedString) + } + } + } + is RepeatCount.MatchLength -> { + val string = value.toString() + + for (i in string.indices) { + append(redactedString) + } + } + } + } +} diff --git a/redacted-core/src/commonMain/kotlin/com.chrynan.redacted.core/RepeatCount.kt b/redacted-core/src/commonMain/kotlin/com.chrynan.redacted.core/RepeatCount.kt new file mode 100644 index 0000000..6cbcb3f --- /dev/null +++ b/redacted-core/src/commonMain/kotlin/com.chrynan.redacted.core/RepeatCount.kt @@ -0,0 +1,8 @@ +package com.chrynan.redacted.core + +sealed class RepeatCount { + + data class Exact(val count: Int) : RepeatCount() + + object MatchLength : RepeatCount() +} diff --git a/redacted-serialization/Module.md b/redacted-serialization/Module.md new file mode 100644 index 0000000..d2c55e6 --- /dev/null +++ b/redacted-serialization/Module.md @@ -0,0 +1,3 @@ +# Module redacted-serialization + +kotlinx.serialization KSerializers for `RedactedProperty`. diff --git a/redacted-serialization/build.gradle b/redacted-serialization/build.gradle new file mode 100644 index 0000000..429fa90 --- /dev/null +++ b/redacted-serialization/build.gradle @@ -0,0 +1,74 @@ +import com.chrynan.redacted.buildSrc.LibraryConstants + +apply plugin: "kotlin-multiplatform" +apply plugin: "kotlinx-serialization" +apply plugin: "maven-publish" +apply plugin: "org.jetbrains.dokka" +apply plugin: "com.chrynan.target.plugin" + +group LibraryConstants.group +version LibraryConstants.versionName + +kotlin { + targets { + jvm() + js() + ios() + } + sourceSets { + all { + languageSettings { + languageSettings.enableLanguageFeature("InlineClasses") + } + } + commonMain { + dependencies { + implementation "org.jetbrains.kotlin:kotlin-stdlib-common" + + implementation project(":redacted-core") + + // Kotlinx Serialization + implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.1.0" + } + } + } +} + +configurations { + compileClasspath +} + +tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).all { + kotlinOptions { + jvmTarget = "1.8" + } +} + +publishing { + repositories { + maven { + url "https://repo.repsy.io/mvn/chrynan/public" + + credentials { + username = project.findProperty("repsyUsername") ?: System.getenv("repsyUsername") + password = project.findProperty("repsyToken") ?: System.getenv("repsyToken") + } + } + } +} + +// Target Information +kotlinTargetDataGenerator { + generateJson = true + generateSvg = true + outputPath = "${projectDir.path}/targets" +} + +// Documentation +tasks.named("dokkaGfm") { + dokkaSourceSets { + configureEach { + includes.from("Module.md") + } + } +} diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..dfd3421 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,4 @@ +rootProject.name = "redacted" + +include ":redacted-core" +include ":redacted-serialization"