cleaned-documentation

PrettyBoyCosmo · PrettyBoyCosmo · commit 3e7f392bb381 · 2023-02-19T10:53:40.000-07:00
diff --git a/README.MD b/README.MD
@@ -1,214 +1,152 @@
 <!-- variables -->
 [ccs]: https://www.cosmodiumcs.com
-[ssg]: https://www.saintssec.com
 [youtube]: https://www.youtube.com/c/CosmodiumCS
 [onlyrat]: https://github.com/CosmodiumCS/OnlyRAT
 
 <!-- title -->
 # SkeletonKey V1.1
 
-Under Development!
-
-### Added:
- - Salt and Raw Hash Function to MD5
- - SHA1 to SHA512 Hashes
- - Blake2b and Blake2s Hashes
- - Twofish Encryption
- - Blowfish Encryption
- - Updated Pixel Encoding
- - Monoalphabetic Cipher
- - URL Encoding
-
-### Plan:
- - Windows Capable
- - Fernet Encryption
- - AES Encryption
- - RSA Encryption
- - 3/DES Encryption
- - Compression Methods
- - Fast Hash Brute Force Option
- - Extend SHA Library
-
----
-
-SkeletonKey is an advanced cryptography hacking tool created by a joint development between [The Societal Security Guild](https://saintssec.com) and [Cosmodium CyberSecurity][ccs]. It was originally two seperate tools, one reffered to as "[Cryptex](https://github.com/SSGorg/Cryptex)" and the other as "[The Codex Project](https://github.com/CosmodiumCS/the-codex-project)". But on May 2, 2022, the lead developers [Cythes](https://github.com/AlexKollar) and [Blue Cosmo](https://github.com/CosmodiumCS) joined forces to build a central cryptography tool. 
-
----
-
-## Hacktoberfest 2022
-Hacktoberfest is a celebration of open-source software, which we are all a advocate for. We believe that you should be able to modify software to work as you need. This is why we are participating in [Hacktoberfest 2022](https://hacktoberfest.com). Successfully making 4 contributions on any participating project will net you some prizes which you can see on the link above.
-
-## How to contribute
-You can contribute by adding anything in the month of October; (any other time not be counted as part of the event, but you are still welcome to contribute) in the form of a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). Simply make a fork of the project, make your changes, and create a pull request to the main project with those changes.  
-
-Be sure to check the issue board if you're not sure how to help!
-
-We will review your changes, suggest edits if needed, and if all checks out - we will add it to the project. If your additions are accepted, they will be merged to the main branch, and your pull request will be marked as Hacktoberfest accepted!
-
-Generally, any contribution you make will be included at the bottom of this README as credit to your work.
-
----
-
-## Earth Invader Discord Bot
-The Earth Invader bot is a Discord API extension of SkeletonKey, bringing the same cryptography tools to Discord as if it was your own cryptography console!
-
-See the repository [here](https://github.com/Soulsender/Earth-Invader).
-
+> A Cryptographic Suite Created by The CosmodiumCS Development Team
 ---
-<!-- EMBED YOUTUBE VIDEO HERE -->
 
-## Requirements
-- Debian/Void/Arch based Linux OS
+## Update 1.2:
+- Code Transcript Cracking
+- Salt and Raw Hash Function to MD5
+- SHA1 to SHA512 Hashes
+- Blake2b and Blake2s Hashes
+- Twofish Encryption
+- Blowfish Encryption
+- Updated Pixel Encoding
+- Monoalphabetic Cipher
+- URL Encoding
+
+## Overview:
+SkeletonKey is an advanced cryptography hacking tool created by [Cosmodium CyberSecurity][ccs] (with an original joint development with SSG). It was originally refereed to as "[The Codex Project](https://github.com/CosmodiumCS/the-codex-project)", and later "Cryptex" after a joint development. After a group conflict, the CCS developers left the group to create "SkeletonKey", which aims to become a leading cryptographic hacking suite. SkeletonKey is capable of advanced encryption, decryption, and breaking ciphers through various methods. These methods include but are not limited to brute-forcing, cryptographic word-listing, letter frequencies, plaintext formatting, and cracking.
+
+## Resources:
+- [YouTube Video](https://www.cosmodiumcs.com/comings-soon)
+- [YouTube Channel](https://youtube.com/cosmodiumcs)
+- [Website](https://cosmodiumcs.com)
+- [Earth Invader](https://github.com/Soulsender/Earth-Invader) (SkeletonKey Discord Bot)
+
+## Requirements:
+- Linux OS (Debian/Void/Arch)
 - Python 3.x
 
-## Set-Up & Installation
+## Installation:
 1. Clone repository
-```
+```bash
 git clone https://github.com/CosmodiumCS/SkeletonKey
 ```
 2. Execute installer
 > **YES** the SkeletonKey directory **IS** supposed to disappear
-```
+```bash
 cd SkeletonKey
 chmod +x
 ./install.sh
 ```
-
 3. Restart your terminal
 
-### Supported Distros
- - Debian (debian-based)
-    - Kali
-    - Parrot
-    - Ubuntu
-    - Mint
- - Arch
- - Void
-
-> See `--help` on `install.sh`.
-
-### Unsupported Distros
-Any unsupported distros you can use `--unsupported-distro` on `install.sh`.
-
-In addition, you will need to install:
- - System Packages:
-    - Python3
-    - Python Pip
- - Python Packages
-    - these can be installed after installing python pip, with `pip3 install -r requirements.txt`
-
-
-
-## Executing SkeletonKey
+## Running SkeletonKey:
 Run the following for help
-```
+```bash
 key --help
 ```
 - The help menu will return a list of all available ciphers
 - You can append the flag for a cipher after `key` to get help for a cipher
 - Here as an example for the Caesar Cipher `cc`
-```
+```key
 key cc
 ``` 
 - The returned arguments can be passed in addition
 - These arguments are the most popular among the ciphers
 - `-e` - encryption
 - `-d` - decryption
-- `-b` - breaking/bruteforcing
+- `-b` - breaking/brute-forcing
 - `-k` - encryption key
 - `-t` - input text
 - `-i` - input file
 - `-o` - output file
-- However, each cipher will have its own uniqe arguments for additional features
-```
+- However, each cipher will have its own unique arguments for additional features
+```bash
 key cc -e -t "hello world" -k 5
 ```
 
-## Cryptconsole
-The Cryptconsole is a more expansive way of using SkeletonKey. It allows the user to open a console in their terminal connected to the SkeletonKey libraries; comparable to [Metasploit](https://www.metasploit.com/) or [OnlyRAT][onlyrat]. The Cryptconsole can allow users to run multiple ciphers back to back to back.
-- We can execute the cryptconsole by running the following
-```
+## Keyconsole:
+The *Keyconsole* is a more expansive way of using SkeletonKey. It allows the user to open a console in their terminal that is directly connected to the SkeletonKey libraries (comparable to [Metasploit](https://www.metasploit.com/) or [OnlyRAT][onlyrat]). The *Keyconsole* can allow users to run multiple ciphers back to back to back.
+- We can execute the *Keyconsole* by running the following:
+```bash
 key
 ```
 - Now multiple ciphers can be run back to back with ease
-```
+```bash
 [~] root@SkeletonKey $ cc -e -t "hello world" -k 5
 ...
 [~] root@SkeletonKey $ vc -e -t "hello world" -k hello
 ```
 - SkeletonKey also has various commands for console interaction
 - `help` - displays help menu
-- `update` - updates crytpex to latest version
+- `update` - updates SkeletonKey to latest version
 - `version` - displays current version
-- `exit` - exits cryptconsole
-- Any other command are run through the commandline
+- `exit` - exits Keyconsole
+- Any other command are run through the command line
 
-## Updating SkeletonKey
-The development team will continuously be pushing out new versions of SkeletonKey. To prevent users from continously having to clone the repository, we made an update function.
-- Argument Parsing
-```
+## Updating SkeletonKey:
+The development team will continuously be pushing out new versions of SkeletonKey. To prevent users from continuously having to clone the repository, we made an update function.
+- **Argument Parsing**:
+```bash
 key --update
 ```
-- CryptConsole
-```
+- **Keyconsole**:
+```bash
 key
 [~] root@SkeletonKey $ update
 ```
 
-## Uninstalling SkeletonKey
-If at anypoint you are unsatisfied or need to rid of the SkeletonKey project [and its awesomeness]. You can run the following to get it off of your computer.
-- Argument Parsing
-```
+## Uninstalling SkeletonKey:
+If at any point you are unsatisfied with the SkeletonKey project [and its awesomeness], You can run the following to get it off of your computer.
+- **Argument Parsing**:
+```bash
 key --remove
 ```
-- CryptConsole
-```
+- **Keyconsole**:
+```bash
 key
 [~] root@SkeletonKey $ remove
 ```
----
-
-## About Us
-**[Soul](https://soulsender.github.io): Lead Discord Bot Dev / Shellscripter / Project Manager**
-Worked on multi-distro (debian/arch/void) installer support for `install.sh`. Lead developer on the [Earth Invader](https://github.com/Soulsender/Earth-Invader) discord bot. Credited with giving SkeletonKey its colors. Also might or might not have had something to do with the original beta name "Earth Invader". 
 
-**[BlueCosmo](https://github.com/PrettyBoyCosmo): Lead Python / Shellscript Developer**
-Started Cosmodium at 17 and since then has made significant changes in the cybersecurity community. A reasonably known content creator and python programming whiz to say the least.    
-  
-**[Fyzz](https://github.com/FyzzLive): Lead Python Developer**   
-Cryptocurrency and cryptography expert, always happy to add another cipher.
+## Earth Invader Discord Bot:
+The Earth Invader bot is a Discord API extension of SkeletonKey, bringing the same cryptography tools to Discord as if it was your own cryptography console! Check it out [here](https://github.com/Soulsender/Earth-Invader).
 
-**[Cythes](https://github.com/AlexKollar): Project Manager (Retired)**
-I started learning computers around middle school age with my discovery & passion of PC Gaming.  A few years later I'd stumbled into Ubuntu 8.04 soon started learning programming, hacking on and off, while over the next decade working on projects ranging from Android personal safety applications to light game development.
-
-**[Mart](https://github.com/marvhus): Developer (Retired)**
-I started tinkering with computers I think around primary school, then in junior high school I started doing more tech stuff, then in high school I started learning more proper programming, and I began to do a lot of programming in my spare time, and at school, but I was always at least 10 steps ahead of what my class was learning, and eventually I ended up finding this place.
-
-## Testers
-- Matze
-- Ibijon
-
-## Sponsors
-- GamerChillz
-
----
-
-## History
-SkeletonKey is an advanced cryptography hacking tool created by a joint development between [The Societal Security Guild](https://saintssec.com) and [Cosmodium CyberSecurity][ccs]. It was originally two seperate tools, one reffered to as "[Cryptex](https://github.com/SSGorg/Cryptex)" and the other as "[The Codex Project](https://github.com/CosmodiumCS/the-codex-project)". But on May 2, 2022, the lead developers [Cythes](https://github.com/AlexKollar) and [Blue Cosmo](https://github.com/CosmodiumCS) joined forces to build a central cryptography tool. 
-
-On August 10th of the same year, due to inner group conflict, many of the developers of Cryptex left to build their own tool named "SkeletonKey".
-
-SkeletonKey is capable of advanced encryption, decryption, and breaking ciphers through various mehtods. These methods include but are not limited to bruteforcing, cryptographic wordlising, letter frequencies, plaintext formatting, and cracking.
-
----      
+## FAQ:
+**What Linux distributions are supported?**
+- Debian (debian-based)
+	- Kali
+	- Parrot
+	- Ubuntu
+	- Mint
+- Arch
+- Void
+> See `--help` on `install.sh`.
 
-## Credits
+**What Linux distributions are not supported?**
+- With any unsupported distributions, you can use `--unsupported-distro` on `install.sh`.
+- In addition, you will need to install:
+	- **System Packages**:
+		- Python3
+		- Python Pip
+	- P**ython Packages**:
+		- After installing python pip, use `pip3 install -r requirements.txt`
+
+## Original Devs:
+- Blue Cosmo
+- Fyzz
+- Soulsender
+- Haze
+
+## Credits:
 As an open source project, SkeletonKey and Earth Invader do use snippets of code inspired and based on other projects such as the following:
-
 - [OnlyRAT](https://github.com/CosmodiumCS/OnlyRAT)
 - [Nirsoft](https://www.nirsoft.net)
 - [Satux](https://cosmodiumcs.com/coming-soon)
-- [Scarab](https://github.com/Soulsender/Scarab)
-
-## Resources
-- [Discord](https://discord.gg/tTKv8w8sHH)
+- [Scarab](https://github.com/Soulsender/Scarab)
diff --git a/main.py b/main.py
@@ -33,7 +33,7 @@ def update():
     print("\n[*] Checking for updates...")
 
     # get latest version nubmer
-    os.system("curl https://raw.githubusercontent.com/AlexKollar/SkeletonKey/master/version.txt | tee ~/.SkeletonKey/latest.txt")
+    os.system("curl https://raw.githubusercontent.com/CosmodiumCS/SkeletonKey/main/version.txt| tee ~/.SkeletonKey/latest.txt")
 
     # save version nubmers to memory
     current_version = float(open(f"{b.local_path}/version.txt", "r").read())
@@ -271,7 +271,7 @@ def cli(args_exist):
             elif user_input.split(' ')[0] not in get_ciphers():
                 os.system(user_input)
 
-            # runs crytpex libraries
+            # runs skeletonkey libraries
             else:
                 os.system(f'python3 ~/.SkeletonKey/main.py {user_input.replace("key", "")}')
 
diff --git a/version.txt b/version.txt
@@ -1 +1 @@
-1.1
+1.2
