Skip to content

Commit

Permalink
Cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
battleoverflow committed Apr 15, 2024
1 parent a25c0ce commit 6b78a7e
Show file tree
Hide file tree
Showing 41 changed files with 90 additions and 90 deletions.
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[package]
name = "catherine"
description = "The Catherine Framework is a general-purpose cybersecurity framework built to provide extended support for defense operations."
version = "0.6.0"
authors = ["azazelm3dj3d"]
version = "0.6.1"
authors = ["battleoverflow"]
license = "BSD-2-Clause"
categories = ["cryptography", "command-line-utilities", "encoding"]
keywords = ["cybersecurity", "blueteam", "framework", "security", "defense"]
edition = "2021"
repository = "https://github.com/azazelm3dj3d/catherine"
repository = "https://github.com/battleoverflow/catherine"

[build-dependencies]
tauri-build = { version = "1.2.1", features = [] }
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 2-Clause License

Copyright (c) 2022, azazelm3dj3d
Copyright (c) 2022-2024, battleoverflow
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
# Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
# Project: Catherine Framework (https://github.com/battleoverflow/catherine)
# Author: battleoverflow (https://github.com/battleoverflow)
# License: BSD 2-Clause

NAME=catherine
PROJ_VERSION=0.6.0
PROJ_VERSION=0.6.1

run:
@echo "Building $(NAME) v$(PROJ_VERSION)"
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
<h1>Catherine</h1>
</div>

[![Catherine](https://github.com/azazelm3dj3d/catherine/actions/workflows/workflow.yml/badge.svg)](https://github.com/azazelm3dj3d/catherine/actions/workflows/workflow.yml)
[![Catherine](https://github.com/battleoverflow/catherine/actions/workflows/workflow.yml/badge.svg)](https://github.com/battleoverflow/catherine/actions/workflows/workflow.yml)

The Catherine Framework is a general-purpose cybersecurity framework built to provide extended support for defense operations. Catherine currently collects information from dumping hexadecimal content from files, validates malicious domains & IP addresses, attempts to crack unknown hashes, handles real-time database analysis, various types of decoding, and much more in a quick CLI utility. Thanks to Catherine being built in an easily packaged executable, you can quickly download the tool by running `cargo install catherine` via the `Cargo` ecosystem. Catherine can also be quickly compiled by pulling down the source code from `git` and simply running `cargo build` or `make` to build alongside modules.

NOTE: Modules do require Go, Python, and C build utilities to be installed.

Catherine provides a Command Line Interface (CLI) and Graphical User Interface (GUI) built into the executable. This means whether you install from source or `Cargo`, you can choose your method of use.

This project will most likely be in an experimental state for a long time. This project is a personal endeavor to explore different ways to control or manipulate data utilizing Rust. A more stable and production-oriented crate is available [here](https://github.com/azazelm3dj3d/mercy). Mercy is an open-source Rust crate and CLI designed for building cybersecurity utilities and projects.
This project will most likely be in an experimental state for a long time. This project is a personal endeavor to explore different ways to control or manipulate data utilizing Rust. A more stable and production-oriented crate is available [here](https://github.com/battleoverflow/mercy). Mercy is an open-source Rust crate and CLI designed for building cybersecurity utilities and projects.

## Installation

Expand All @@ -26,7 +26,7 @@ If you'd prefer to install from source, you can also do this fairly easily, but
First, clone the repository using `git`:

```bash
git clone https://github.com/azazelm3dj3d/catherine.git
git clone https://github.com/battleoverflow/catherine.git
```

Once you've cloned the repository, and you're in the correct directory, simply run the following command:
Expand All @@ -43,7 +43,7 @@ If you're interested in working with the Catherine modules, you can use the `mak
make
```

I am working on converting all external [modules](https://github.com/azazelm3dj3d/catherine-modules) (Python, C, Go) into native modules (Rust) to offer everything in a built-in executable via `Cargo` without any extra steps, but for now, I've made sure to keep them accessible (excluding the GUI) for extended functionality.
I am working on converting all external [modules](https://github.com/battleoverflow/catherine-modules) (Python, C, Go) into native modules (Rust) to offer everything in a built-in executable via `Cargo` without any extra steps, but for now, I've made sure to keep them accessible (excluding the GUI) for extended functionality.

## Usage

Expand All @@ -59,6 +59,6 @@ If a GUI is more your style, there is a simple version available with the majori
🦀 Catherine [v0.x.x] (None) ☀️ 〉launch
```

If a bug or issue is found, please report it [here](https://github.com/azazelm3dj3d/catherine/issues).
If a bug or issue is found, please report it [here](https://github.com/battleoverflow/catherine/issues).

*GUI logo provided by Freepik w/ modification from azazelm3dj3d.
*GUI logo provided by Freepik w/ modification from battleoverflow.
4 changes: 2 additions & 2 deletions build.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions build_modules.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash

# Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
# Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
# Project: Catherine Framework (https://github.com/battleoverflow/catherine)
# Author: battleoverflow (https://github.com/battleoverflow)
# License: BSD 2-Clause

# NetScan
Expand Down
2 changes: 1 addition & 1 deletion modules.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"author": "azazelm3dj3d",
"author": "battleoverflow",
"version": "0.1.26",
"numOfModules": "6",
"ModulesList": [
Expand Down
4 changes: 2 additions & 2 deletions public/crack_hash.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down
4 changes: 2 additions & 2 deletions public/decode.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down
4 changes: 2 additions & 2 deletions public/defang.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down
4 changes: 2 additions & 2 deletions public/extract_zip.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down
4 changes: 2 additions & 2 deletions public/gen_domain.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down
4 changes: 2 additions & 2 deletions public/identify.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down
6 changes: 3 additions & 3 deletions public/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down Expand Up @@ -94,7 +94,7 @@
<div class="grid place-items-center h-screen">
<img src="catherine_icon.png" class="shadow-2xl" alt="Skull logo representing the Catherine framework">
<p class="text-white text-lg">
Built by azazelm3dj3d (https://github.com/azazelm3dj3d)
Built by battleoverflow (https://github.com/battleoverflow)
</p>
</div>
</main>
Expand Down
4 changes: 2 additions & 2 deletions public/js/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions public/parse_email.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down
4 changes: 2 additions & 2 deletions public/sysdump.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down
4 changes: 2 additions & 2 deletions public/whois.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down
4 changes: 2 additions & 2 deletions server/public/err/404.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down
4 changes: 2 additions & 2 deletions server/public/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
-->

Expand Down
10 changes: 5 additions & 5 deletions src/catherine.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down Expand Up @@ -54,7 +54,7 @@ use crate::ui::controller::launch_gui;
extern crate ipconfig;

pub(crate) static NAME: &str = "Catherine";
pub(crate) static VERSION: &str = "0.6.0";
pub(crate) static VERSION: &str = "0.6.1";

pub(crate) static NETSCAN_PATH: &str = "/opt/catherine/catherine-modules/net/netscan/netscan";
pub(crate) static LINK_PARSER_PATH: &str = "/opt/catherine/catherine-modules/web/parsers/links";
Expand Down Expand Up @@ -253,7 +253,7 @@ pub fn init(boot_msg: &str) {

"version" => {
println!("\nCatherine Framework v{}", VERSION);
println!("Author: azazelm3dj3d (https://github.com/azazelm3dj3d)\n");
println!("Author: battleoverflow (https://github.com/battleoverflow)\n");
},

// Installs custom modules
Expand All @@ -274,7 +274,7 @@ pub fn init(boot_msg: &str) {
}

// Downloads Catherine modules from GitHub
git_downloader("https://github.com/azazelm3dj3d/catherine-modules.git");
git_downloader("https://github.com/battleoverflow/catherine-modules.git");

if existence("/opt/catherine") {
println!("\nInstallation complete! Modules can be found here: /opt/catherine/catherine-modules\n");
Expand Down
4 changes: 2 additions & 2 deletions src/core/commands.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions src/core/mod.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions src/core/shell.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions src/core/utils.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions src/main.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions src/meta.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions src/modules/db/redis.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# -*- coding: utf-8 -*-

"""
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
"""

Expand Down
4 changes: 2 additions & 2 deletions src/modules/formats/exe/win_exe_dump.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
"""

Expand Down
4 changes: 2 additions & 2 deletions src/modules/formats/hex/c_hex_dump.c
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions src/modules/formats/hex/mod.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions src/modules/formats/hex/rs_hex_dump.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions src/modules/formats/mod.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
4 changes: 2 additions & 2 deletions src/modules/mercy/extension.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
"""

Expand Down
4 changes: 2 additions & 2 deletions src/modules/mod.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
Project: Catherine Framework (https://github.com/azazelm3dj3d/catherine)
Author: azazelm3dj3d (https://github.com/azazelm3dj3d)
Project: Catherine Framework (https://github.com/battleoverflow/catherine)
Author: battleoverflow (https://github.com/battleoverflow)
License: BSD 2-Clause
*/

Expand Down
Loading

0 comments on commit 6b78a7e

Please sign in to comment.