Added licence and readme

This commit is contained in:
Flare Microsystems
2024-11-17 08:03:48 -08:00
parent d63ea7ba77
commit 766fafcf10
2 changed files with 364 additions and 0 deletions

25
README.md Normal file
View File

@@ -0,0 +1,25 @@
# CrossJeeves - Script Executor
For when Jenkin's Hands are Full
CrossJeeves is made to bypass the limitations of Jenkins requiring Java 17 for agents. This is a neiche application for neiche projects that require building on legacy devices with legacy compilers and no support for newer Java, so all code submitted to this repository ***MUST*** support Java 5 or lower.
# WARNING
CROSSJEEVES IS REMOTE CODE EXECUTION BY DESIGN!
Currently, there *is* no verification, encryption, or any sort of security. This is a BETA PROJECT and should only be used on closed networks, preferrably on a private build network as these are already legacy machines. The hosted CrossJeeves port should ***NEVER*** be forwarded.
# TODO
See Issues for a more comprehensive "Todo" list
- Better Logging and Log Levels
- Using the native Java logger along with a log level sent in the Identity packet
- Custom logger will send only the log for the agent to the agent, but will be much more detailed than the current process logger
- Auto-Updater
- CrossJeeves is it's own client and agent, and every agent should be updated if a newer agent calls it, unless specified.
- In case of disaster, a backup method of updating should be availible
- Console
- Currently CTRL+C is the only way to terminate an agent. There should be more console-based commands.
- General code clean-up and improvement
- TCP/IP code is especially ugly
- Encryption
- Packets should use encryption to ensure they aren't tampered with
- Agents should have certificates to verify they are indeed talking to a valid client.
- Certificates should be the discression of the installer, rather than part of the program itself.