Merge pull request #26 from michael2to3/feature/docker

Add support docker

Author: michael2to3

.gitignore

@@ -624,3 +624,4 @@ config.properties
 test.prop
 test.properties
 log4j.properties
+.env

Dockerfile

@@ -1,5 +1,4 @@
-FROM openjdk:11-jre-slim-buster
+FROM adoptopenjdk/openjdk16:alpine-jre
 WORKDIR /app
-COPY . /app
-RUN ./gradlew build
-CMD ["java", "-jar", "app/build/libs/c2-search-netlas-1.0-SNAPSHOT.jar"]
+COPY ./app/build/libs/app-all.jar app.jar
+ENTRYPOINT ["java", "-jar", "app.jar"]

README.md

@@ -20,13 +20,9 @@ After acquiring your API key, execute the following command to search servers:
 ```bash
 c2detect -t <TARGET_DOMAIN> -p <TARGET_PORT> -s <API_KEY> [-v]
 ```
-
 Replace `<TARGET_DOMAIN>` with the desired IP address or domain, `<TARGET_PORT>` with the port you wish to scan, and `<API_KEY>` with your Netlas API key.
-
 Use the optional `-v` flag for verbose output.
-
 For example, to search at the `google.com` IP address on port `443` using the Netlas API key `1234567890abcdef`, enter:
-
 ```bash
 c2detect -t google.com -p 443 -s 1234567890abcdef
 ```
@@ -36,62 +32,27 @@ To download a release of the utility, follow these steps:
 
 - Visit the repository's releases page on GitHub.
 - Download the latest release file (typically a JAR file) to your local machine.
-- In the same directory as the JAR file, create a `config.properties` file and add this line:
-
-```bash
-api.key=<your-netlas-api-key>
-```
-
-- Replace `<your-netlas-api-key>` with your actual Netlas API key.
-- In a terminal, navigate to the directory containing the JAR and `config.properties` files.
+- In a terminal, navigate to the directory containing the JAR file.
 - Execute the following command to initiate the utility:
 ```bash
-java -jar c2-search-netlas-<version>.jar -t <ip-or-domain> -p <port>
-```
-- Replace `<version>` with the version number of the release you downloaded, `<ip-or-domain>` with the IP address or domain you want to search for C2 servers on, and `<port>` with the port you want to scan.
-
-## Docker compose
-To build and run the utility using Docker Compose, follow these steps:
-- Clone the repository to your local machine:
-```bash
-git clone https://github.com/michael2to3/c2-search-netlas.git
-```
-- Navigate to the repository directory:
-```bash
-cd c2-search-netlas
-```
-- Create a config.properties file in the root directory of the project and add the following line:
-```bash
-api.key=<your-netlas-api-key>
-```
-- Replace `<your-netlas-api-key>` with your actual Netlas API key.
-- Open the `.env` file and replace the value of the `API_KEY` environment variable with your actual Netlas API key.
-- Run the following command to build and start the Docker containers:
-
-```bash
-docker-compose up --build
+java -jar c2-search-netlas-<version>.jar -t <ip-or-domain> -p <port> -s <your-netlas-api-key>
 ```
-- Open another terminal and run the following command to search for C2 servers:
-```bash
-docker-compose exec c2detect c2detect -t <ip-or-domain> -p <port>
-```
-Replace `<ip-or-domain>` with the IP address or domain you want to search for C2 servers on, and `<port>` with the port you want to scan.
 
 ## Docker
 To build and start the Docker container for this project, run the following commands:
 ```bash
-docker build -t <image-name> .
-docker run -p 8080:8080 <image-name>
+docker build -t c2detect .
+docker run -it --rm \
+  c2detect \
+  -s "your_api_key" \
+  -t "your_target_domain" \
+  -p "your_target_port" \
+  -v
 ```
-Replace `<image-name>` with the name you want to give your Docker image. This will build the Docker image and start the container.
 
 ## Source
 
 To use this utility, you need to have a Netlas API key. You can get the key from the Netlas website.
-Once you have the API key, create a config.properties file in the root directory of the project and add the following line:
-```bash
-api.key=<your-netlas-api-key>
-```
 Now you can build the project and run it using the following commands:
 ```bash
 ./gradlew build
@@ -100,7 +61,7 @@ java -jar app/build/libs/c2-search-netlas-1.0-SNAPSHOT.jar --help
 This will display the help message with available options.
 To search for C2 servers, run the following command:
 ```bash
-java -jar app/build/libs/c2-search-netlas-1.0-SNAPSHOT.jar -t <ip-or-domain> -p <port>
+java -jar app/build/libs/c2-search-netlas-1.0-SNAPSHOT.jar -t <ip-or-domain> -p <port> -s <your-netlas-api-key>
 ```
 This will display a list of C2 servers found in the given IP address or domain.
 
@@ -135,3 +96,5 @@ If you'd like to contribute to this project, please feel free to create a pull r
 ## License
 
 This project is licensed under the License - see the [LICENSE](https://github.com/michael2to3/c2-search-netlas/blob/main/LICENSE) file for details.
+
+