Merge pull request #3 from CatherineFramework/dev

New Release: v1.2.x

Cargo.toml

@@ -1,13 +1,13 @@
 [package]
 name = "mercy"
-version = "1.1.12"
+version = "1.2.16"
 edition = "2021"
-authors = ["Hifumi1337"]
+authors = ["azazelm3dj3d"]
 license = "BSD-2-Clause"
 categories = ["cryptography", "encoding"]
 keywords = ["hashing", "decode", "encode", "cracking"]
-description = "Mercy is a public Rust crate created to assist with building cybersecurity frameworks, assessment tools, and numerous other projects"
-repository = "https://github.com/cybersuki/mercy"
+description = "Mercy is a public Rust crate created to assist with building cybersecurity frameworks (offensive and defensive) and assessment tools. The goal is to create a sustainable crate to make creating security tools in Rust a little easier."
+repository = "https://github.com/CatherineFramework/mercy"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -16,4 +16,8 @@ base64 = "0.13.0"
 sha2 = "0.10"
 md5 = "0.7.0"
 hexdump = "0.1.1"
-sys-info = "0.9.0"
+sys-info = "0.9.0"
+serde = "1.0"
+serde_json = "1.0"
+reqwest = { version = "0.11", features = ["json"] }
+tokio = { version = "1", features = ["full"] }

LICENSE

@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2022, CyberSuki
+Copyright (c) 2022, azazelm3dj3d
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,40 +1,35 @@
 <h1 align="center">
-    <img src="assets/mercy_banner_v1.png" />
-    <br />
-    Mercy
+    <img src="assets/mercy_icon.png" width="50%" />
 </h1>
 
-<h3 align="center">
-    📚 <a href="https://docs.rs/mercy/latest/mercy/">Documentation</a>
-</h3>
-<br>
+📚 [Documentation](https://docs.rs/mercy/latest/mercy/)
 
-Mercy is a public Rust crate created to assist with building cybersecurity frameworks, assessment tools, and numerous other projects. We hope to create a sustainable crate to make creating security tools in Rust a little easier and not require so much bloat in your project.
+Mercy is a public Rust crate created to assist with building cybersecurity frameworks (offensive and defensive) and assessment tools. The goal is to create a sustainable crate to make creating security tools in Rust a little easier.
 
 ## Usage
-Since Mercy is a standard crate, it can easily be utilized in any project already initialized with the Cargo configuration.
+Since Mercy is a standard crate, it can easily be utilized in any project already initialized with Cargo.
 
 Add the following line to your `Cargo.toml` file:
 ```toml
-mercy = "1.1.12"
+mercy = "1.2.16"
 ```
 
-Once the `Cargo.toml` file has been updated, you can import the crate and use the provided methods by running `cargo run`.
+Once the `Cargo.toml` file is updated, you can import the crate and use the provided methods by running `cargo run`. There are lots of different examples available below.
 
 ### Cryptographic Processes
-Here's a quick example for decoding and encoding using the base64 protocol:
+Here's a quick example of decoding and encoding using the base64 protocol:
 ```rust
 use mercy::{
     mercy_decode,
     mercy_encode
 };
 
 fn main() {
-    // Encode string "CyberSuki"
-    mercy_encode("base64", "CyberSuki");
+    // Encode string "azazelm3dj3d"
+    mercy_encode("base64", "azazelm3dj3d");
 
-    // Decode string "Q3liZXJTdWtp"
-    mercy_decode("base64", "Q3liZXJTdWtp");
+    // Decode string "YXphemVsbTNkajNk"
+    mercy_decode("base64", "YXphemVsbTNkajNk");
 }
 ```
 
@@ -48,20 +43,36 @@ fn main() {
 }
 ```
 
+### Malware/Malicious Detection
+You can check if a domain (i.e. google.com) is currently classified as malicious using the InQuest API:
+```rust
+use mercy::mercy_malicious;
+
+fn main() {
+    mercy_malicious("status", "azazelm3dj3d.com");
+}
+```
+
 ### Miscellaneous Methods
-Some extra methods have been included to assist with local data collection. We currently allow you to collect the internal ip address of your device or dump certain information, specified by the user.
+Some extra methods have been included to assist with data collection. You can currently collect the internal IP address of the host system, defang a URL or IP address, run a WHOIS domain lookup, or dump host system information, specified by the user.
 ```rust
 use mercy::mercy_extra;
 
 fn main() {
     // Contains the internal ip address of the user's system
-    mercy_extra("internal_ip", "");
+    mercy_extra("internal_ip", ""); // Second parameter MUST be an empty string to work
 
     // This method is extensive, but the "all" parameter allows the user to dump everything we have set in Mercy
     mercy_extra("system_info", "all");
+
+    // Method now available which allows you to defang a url or ip address
+    mercy_extra("defang", "azazelm3dj3d.com");
+
+    // Run a WHOIS lookup for a domain
+    mercy_extra("whois", "azazelm3dj3d.com");
 }
 ```
-We can also use the following paremeters, replacing the "all" keyword:
+You can also use the following parameters, replacing the "all" keyword under `system_info`:
 
 - hostname
 - cpu_cores