added screenshots for README.md, actual build. changed name. added ci…

…/cd integration

.github/workflows/CI_CD.yaml

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'corretto'
+      - name: Build with Maven
+        run: mvn --batch-mode --update-snapshots clean package

README.md

@@ -0,0 +1,47 @@
+# JAVA HASHCODE BREAKER
+
+# Motivation
+
+The most popular and powerful tools such as [Hashcat](https://github.com/hashcat)
+or [John The Ripper](https://www.openwall.com/john/) used to be as default
+hash cracking tools. But to some unknown reasons neither hashcat no john couldn't crack simple Java Object hashcode
+function. And even a lot of instruments couldn't identify such type of hash. This is very strange because sometimes Java
+developers converts users passwords with simple hashcode function and pushes in to database which make dictionary
+attack reasonable. Also, if you don't want to pay to crack you hash on resources
+as [Hashes.com](https://hashes.com/en/credits) you may use this tool for testing.
+
+### Some additional information
+[Hashcat: issue Java hashCode() Token Length Exception with Hex integer](https://github.com/hashcat/hashcat/issues/3559)
+
+![simple_java_hash.png](assets%2Fsimple_java_hash.png)
+![hash_unknown_hash.png](assets%2Fhash_unknown_hash.png)
+![hashid_unknown_hash.png](assets%2Fhashid_unknown_hash.png)
+![hashcat_unknown_hash.png](assets%2Fhashcat_unknown_hash.png)
+![john_unknown_hash.png](assets%2Fjohn_unknown_hash.png)
+
+# Usage
+1. Clone the repository
+2. Change path to builds 
+    ```
+    cd java_hashcode_breaker/builds
+    ```
+3. Run .jar file with options below
+    ```
+    java -jar <current build vesion>.jar -h <provide hash here> -w <path to wordlist>
+   ```
+4. You can add -v option for verbose output 
+    ```
+    java -jar <current build vesion>.jar -h <provide hash here> -w <path to wordlist> -v
+    ```
+5. Happy cracking.
+
+### Example of work
+Without verbosity
+
+![example.png](assets%2Fexample.png)
+
+With -v option
+
+![example_verbose.png](assets%2Fexample_verbose.png)
+
+

pom.xml

@@ -9,7 +9,7 @@
         <relativePath/>
     </parent>
     <groupId>com.exploitable</groupId>
-    <artifactId>java-hashcode-cracker</artifactId>
+    <artifactId>java-hashcode-breaker</artifactId>
     <version>0.1.0</version>
     <name>java-hashcode-cracker</name>
     <description>java-hashcode-cracker</description>
@@ -46,6 +46,14 @@
     </dependencies>
 
     <build>
+        <resources>
+            <resource>
+                <directory>assets</directory>
+                <excludes>
+                    <exclude>*</exclude>
+                </excludes>
+            </resource>
+        </resources>
         <plugins>
             <plugin>
                 <groupId>org.springframework.boot</groupId>
@@ -58,7 +66,7 @@
                         </goals>
                         <configuration>
                             <mainClass>
-                                com.exploitable.javahashcodecracker.JavaHashcodeCrackerApplication
+                                com.exploitable.javahashcodebreaker.JavaHashcodeCrackerApplication
                             </mainClass>
                         </configuration>
                     </execution>

src/main/java/com/exploitable/javahashcodecracker/Config.java → src/main/java/com/exploitable/javahashcodebreaker/Config.java

@@ -1,4 +1,4 @@
-package com.exploitable.javahashcodecracker;
+package com.exploitable.javahashcodebreaker;
 
 
 import org.apache.commons.cli.CommandLineParser;

src/main/java/com/exploitable/javahashcodecracker/HashCrackService.java → src/main/java/com/exploitable/javahashcodebreaker/HashCrackService.java

@@ -1,4 +1,4 @@
-package com.exploitable.javahashcodecracker;
+package com.exploitable.javahashcodebreaker;
 
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;

src/main/java/com/exploitable/javahashcodecracker/JavaHashcodeCrackerApplication.java → src/main/java/com/exploitable/javahashcodebreaker/JavaHashcodeCrackerApplication.java

@@ -1,4 +1,4 @@
-package com.exploitable.javahashcodecracker;
+package com.exploitable.javahashcodebreaker;
 
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.boot.CommandLineRunner;

src/test/java/com/exploitable/javahashcodecracker/JavaHashcodeCrackerApplicationTests.java → src/test/java/com/exploitable/javahashcodebreaker/JavaHashcodeBreakerApplicationTests.java

@@ -1,4 +1,4 @@
-package com.exploitable.javahashcodecracker;
+package com.exploitable.javahashcodebreaker;
 
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Order;
@@ -14,9 +14,9 @@
 import java.util.Random;
 
 @SpringBootTest
-class JavaHashcodeCrackerApplicationTests {
+class JavaHashcodeBreakerApplicationTests {
 
-    private final static File rockyouFile = new File("src/test/java/com/exploitable/javahashcodecracker/rockyousmall-3000.txt");
+    private final static File rockyouFile = new File("src/test/java/com/exploitable/javahashcodebreaker/rockyousmall-3000.txt");
 
     @Autowired
     private HashCrackService hashCrackService;