diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + + 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..d1e75ed --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# Encrypter + +This is a small library used to encrypt passwords. + + + +`com.lobosstudios.crypter.Encrypter.encrypt(String unencrypted, String ourSalt)` generates a hash using SHA-512. The encrypted password is prefixed with the string `{CRYPT}` (for historical reasons that probably won't make sense to anyone except me; I lifted the code from a small library I wrote years ago). + +If you are generating a hash from a plaintext password, `ourSalt` must be null. The salt is only specified when you are verifying a password. + +`com.lobosstudios.crypter.Encrypter. verify(String encrypted, String passwordToVerify)` returns true if the encrypted hash matches the unencrypted password. The passwords are compared this way: +* The salt is extract from the encrypted password. +* `encrypt()` is called, passing the plaintext password and the salt. +* Given the same salt and the same plaintext password, `encrypt()` will return the same string we passed in. If the string we generate is identical to `encrypted`, we return true; otherwise we return false. + +## CLI + +`java -jar crypter-VERSION-all.jar [ -v | --verify]` + +Allows you to generate a password, and copies the encrypted password to the clipboard, unless `-v` or `--verify` is specified, in which case you are prompted +for the encrypted password, then you are prompted for a plaintext password, and the two are compared; you are told either that they match, or they don't match. + +If `-v` or `--verify` is specified, the option must come AFTER `-jar`. + +## Dependencies + +Crypter's only dependency is on the Apache Commons Codec library. + +## Maven Coordinates + +Crypter is hosted in Lobos Studios' `java-dev` repository. + +To use the repo with Gradle: + +```groovy +repositories { + mavenCentral() + maven { + url "https://repos.lobosstudios.com/repository/java-dev/" + } +} + +dependencies { + implementation "com.lobosstudios:crypter:[VERSION]" +} +``` + +To use it with Maven: + +```xml + + + lobosstudios-nexus-java-dev + Lobos Studios java-dev + https://repos.lobosstudios.com/repository/java-dev/ + + + + + + com.lobosstudios + crypter + [VERSION] + + +``` + +***repos.lobosstudios.com is hosted on a Sonatype Nexus server. Repos hosted on Nexus require the slash at the end of the URL. Don't forget it!*** diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..a922947 --- /dev/null +++ b/build.gradle @@ -0,0 +1,56 @@ +plugins { + id 'java' + id 'application' + id 'maven-publish' + id "io.github.gradle-nexus.publish-plugin" version "1.1.0" + id 'com.github.johnrengelman.shadow' version '8.1.1' +} + +def ourGroupId = 'com.lobosstudios' +def ourArtifactId = 'crypter' +def ourVersionNumber = '1.0.0' + +group ourGroupId +version ourVersionNumber + +def scmUrl = 'git@github.com:lobosstudios/crypter.git' +def licenseName = 'MIT' +def licenseUrl = 'https://opensource.org/license/mit' + +repositories { + mavenCentral() +} + +dependencies { + implementation group: 'commons-codec', name: 'commons-codec', version: '1.17.1' +} + +application { + mainClass = 'com.lobosstudios.crypter.Main' +} + + +publishing { + publications { + maven(MavenPublication) { + groupId = ourGroupId + artifactId = ourArtifactId + version = ourVersionNumber + + from components.java + } + } +} + +nexusPublishing { + useStaging = false + repositories { + myNexus { + nexusUrl = uri(maven1Url) + snapshotRepositoryUrl = uri(maven1Url) + username = maven1User + password = maven1Password + } + } +} + diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..bc4e065 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,2 @@ +rootProject.name = 'crypter' + diff --git a/src/main/java/com/lobosstudios/crypter/Encrypter.java b/src/main/java/com/lobosstudios/crypter/Encrypter.java new file mode 100644 index 0000000..76763fe --- /dev/null +++ b/src/main/java/com/lobosstudios/crypter/Encrypter.java @@ -0,0 +1,38 @@ +package com.lobosstudios.crypter; + +import java.util.Random; +import org.apache.commons.codec.digest.Crypt; + +public class Encrypter { + private final static int saltSize = 20; + + // SHA512crypt + public static String encryptSha512(String unencoded, String ourSalt) { + String hashChars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; + hashChars += "abcdefghijklmnopqrstuvwxyz"; + hashChars += "1234567890"; + + int[] integers = new Random().ints(saltSize, 0, hashChars.length()-1).toArray(); + + String salt; + + if (ourSalt == null) { + StringBuilder saltBuilder = new StringBuilder(); + saltBuilder.append("$6$"); // SHA-512 + for (int i = 0; i < saltSize; i++) { + saltBuilder.append(hashChars, integers[i], integers[i]+1); + } + salt = saltBuilder.toString(); + } else { + salt = "$6$" + ourSalt; + } + + String h = Crypt.crypt(unencoded, salt); + return "{CRYPT}" +h; + } + + public static boolean verify(String encrypted, String passwordToVerify) { + String salt = encrypted.substring(10, 10 + (saltSize-4)); + return encrypted.equals(encryptSha512(passwordToVerify, salt)); + } +} diff --git a/src/main/java/com/lobosstudios/crypter/Main.java b/src/main/java/com/lobosstudios/crypter/Main.java new file mode 100644 index 0000000..9247506 --- /dev/null +++ b/src/main/java/com/lobosstudios/crypter/Main.java @@ -0,0 +1,74 @@ +package com.lobosstudios.crypter; + +import java.awt.Toolkit; +import java.awt.datatransfer.Clipboard; +import java.awt.datatransfer.ClipboardOwner; +import java.awt.datatransfer.StringSelection; +import java.awt.datatransfer.Transferable; +import java.util.Arrays; + +public class Main implements ClipboardOwner { + public static void main(String[] args) throws Exception { + if (args.length == 0) { + new Main().encryptNewPassword(); // clipboard.setContents() can't be used in a static context) + return; + } + + if (args[0].equals("-v") || args[0].equals("--verify")) + verifyPassword(); + else + new Main().encryptNewPassword(); // clipboard.setContents() can't be used in a static context) + } + + private void encryptNewPassword() { + System.out.println(); + String passwordToEncrypt = getPassword(true); + String encrypted = Encrypter.encryptSha512(passwordToEncrypt, null); + + Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard(); + StringSelection contents = new StringSelection(encrypted); + clipboard.setContents(contents, this); + + System.out.println(encrypted + " copied to clipboard"); + System.out.println(); + } + + private static void verifyPassword() { + System.out.println(); + System.out.print("Encrypted password: "); + String encrypted = String.valueOf(System.console().readLine()); + System.out.println(); + System.out.print("Plaintext password: "); + String plaintext = String.valueOf(System.console().readPassword()); + + System.out.println(); + if (Encrypter.verify(encrypted, plaintext)) + System.out.println("Passwords match"); + else + System.out.println("Passwords do not match"); + System.out.println(); + } + + private static String getPassword(boolean askForConfirmation) { + boolean done = false; + char[] password = null; + + while (!done) { + System.out.println(); + System.out.print("Password: "); + password = System.console().readPassword(); + if (!askForConfirmation) { + done = true; + } else { + System.out.print("Confirm password: "); + char[] confirmation = System.console().readPassword(); + + if (Arrays.equals(password, confirmation)) done = true; + } + } + return String.valueOf(password); + } + + @Override + public void lostOwnership(Clipboard clipboard, Transferable contents) {} +} \ No newline at end of file