PixelRidge-Softworks/NETRAVE
PixelRidge-Softworks/NETRAVE
3
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README, create CHANGELOG

Browse Source
This commit is contained in:
VetheonGames 2023-07-30 18:41:20 -06:00
parent a4b2b878ea
commit c5ff5ce0b2
2 changed files with 39 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
CHANGELOG.md Normal file
View File

@ -0,0 +1,32 @@
# Changelog
**Note:** This changelog might be incomplete. For a complete list of changes, please check the commit history in the repository.
## Commits on Jun 10, 2023
- **Refactoring Database Interaction Methods** (Commit: [335cd89](https://github.com/PixelRidge-Softworks/NETRAVE/commit/335cd89ebee60252cb9948c84d981aff715b0be1))
- Significant refactoring of the database interaction methods in the NETRAVE project. Simplified the interaction with the database and resolved a `Sequel::DatabaseError` that was encountered during the execution of the `store_services` method.
## Commits on Jun 7, 2023
- **Setup a project dependant rubocop for ease of development** (Commit: [f96cf9e](https://github.com/PixelRidge-Softworks/NETRAVE/commit/f96cf9e20a2f1325be4d33a8d2ceb698011b343e))
- Included the project specific settings files so that fellow VS Code users can just clone down the repo, and install the needed extensions.
- **Update TODO.md** (Commit: [3d2a632](https://github.com/PixelRidge-Softworks/NETRAVE/commit/3d2a632b0e812327ae7592534449c695c90c89e5))
- **Merge pull request #2 from Pixelated-Studios/vetheon-patch-2** (Commit: [982c404](https://github.com/PixelRidge-Softworks/NETRAVE/commit/982c404472655cf34bf316dcf2ab7d6ae1bae266))
- Enhancing User Experience by Streamlining Database Connection Setup
- **Enhancing User Experience by Streamlining Database Connection Setup** (Commit: [6768cf1](https://github.com/PixelRidge-Softworks/NETRAVE/commit/6768cf14b3d95e68b6150bc50419ed88e41c661b))
- Made significant improvements to the user experience of the NETRAVE project by streamlining the process of setting up the database connection.
## Commits on Jun 5, 2023
- **Merge pull request #1 from Pixelated-Studios/VetheonGames-patch-1** (Commit: [72a7775](https://github.com/PixelRidge-Softworks/NETRAVE/commit/72a77754cdba263a4fde12907f688ef0d9d7a70b))
- Update README.md
- **Update README.md** (Commit: [28960fa](https://github.com/PixelRidge-Softworks/NETRAVE/commit/28960fa3fceea8f7d70467d9ba88dd641b9e12f8))
- **Update issue templates** (Commit: [0a27925](https://github.com/PixelRidge-Softworks/NETRAVE/commit/0a279254052e09d87c897f327ed0e680e3bb4c4d), [92499ec](https://github.com/PixelRidge-Softworks/NETRAVE/commit/92499eccd59efcd4a30e5baef8d99d7e046e6045))
- **Create SECURITY.md** (Commit: [6615a99](https://github.com/PixelRidge-Softworks/NETRAVE/commit/6615a99317a954888bfaa775bc09c5be6d1d6e8f))

11
README.md
View File

@ -12,6 +12,7 @@ Come chat with us on [![Discord](https://img.shields.io/discord/8656525939326321
7. [Contact](#contact)
8. [Conclusion](#conclusion)
9. [Special Thanks](#special-thanks)
10. [NPEP Specification](https://git.pixelridgesoftworks.com/PixelRidge-Softworks/NETRAVE/NPEP.spec.md)
## Introduction
Welcome to NETRAVE, a cybersecurity solution designed to provide a high level of security, vigilance, and response to threats, ensuring that network environments remain secure and resilient. This README provides a comprehensive overview of the software, its purpose, functions, objectives, and unique methods of handling issues/challenges.
@ -25,9 +26,11 @@ Connor Crawford, also known as Vetheon, is currently the only developer behind N
## Technical Overview
NETRAVE is designed with a modular architecture, which allows for easy customization, upgrades, and maintenance. Each module in NETRAVE is designed to perform a specific function, and they can work independently or in harmony, depending on the needs of the user.
The software is built using Ruby, a high-level, interpreted programming language that emphasizes simplicity and productivity. Ruby's dynamic typing and object-oriented design make it an ideal choice for a modular system like NETRAVE.
The software is built using a combination of Ruby and Go. Ruby, a high-level, interpreted programming language that emphasizes simplicity and productivity, is used for the main orchestrator and the overall structure of the software. Ruby's dynamic typing and object-oriented design make it an ideal choice for a modular system like NETRAVE.
Recent updates include the implementation of a secure sudo system, and the creation of a NetworkingGenie class to handle network interface setup and traffic mirroring. The AlertQueueManager class has also been updated to use a standard Array queue instead of a Ring Buffer for managing the queue of alerts.
Go, a statically typed, compiled language known for its efficiency and concurrency, is used for the packet capture and processing modules. These modules are compiled into shared C libraries using cgo, a feature of Go that enables the creation of Go packages that call C code. These shared libraries are then accessed from Ruby using the Foreign Function Interface (FFI), which allows Ruby code to call functions written in other languages directly.
This combination of Ruby and Go, along with the use of shared C libraries, allows NETRAVE to leverage the strengths of both languages. The simplicity and productivity of Ruby for the overall structure and orchestration, and the efficiency and concurrency of Go for the performance-critical packet capture and processing tasks.
## Modular Design
The modular design of NETRAVE is one of its key features. Each module is designed to perform a specific function, and they can work independently or in harmony, depending on the needs of the user. This design allows for easy customization, upgrades, and maintenance.
@ -37,10 +40,10 @@ The modular design also allows for easy expansion. New modules can be added to t
## Contributing
NETRAVE is an open-source project, and contributions are welcome. If you're interested in contributing, please fork the repository and make your changes. Once you're done, submit a pull request. All contributions, no matter how small, are greatly appreciated.
If you're looking for something to do, you can have a look in our [TODO List](https://github.com/Pixelated-Studios/NETRAVE/blob/main/TODO.md)
If you're looking for something to do, you can have a look in our [TODO List](https://git.pixelridgesoftworks.com/PixelRidge-Softworks/NETRAVE/blob/main/TODO.md)
## Contact
Connor is always open to receiving questions. If you have any questions, suggestions, or just want to say hi, you can reach him at vetheon@pixelatedstudios.net or on discord via VetheonGames#0001.
Connor is always open to receiving questions. If you have any questions, suggestions, or just want to say hi, you can reach him at connorc@pixelridgesoftworks.com or on discord via VetheonGames#0001.
## Conclusion
NETRAVE is a robust, modular cybersecurity solution that provides a high level of security, vigilance, and response to threats. Its open-source nature and modular design make it a flexible and adaptable solution that can meet the changing needs of any network environment. Whether you're a network administrator looking for a comprehensive security solution, or a developer interested in contributing to an open-source project, NETRAVE has something to offer you.