README
¶
Horusec Development Kit
Table of contents
1. About
2. Usage
2.1. How does DevKit work?
3. Features
4. Documentation
5. Issues
6. Contributing
7. License
8. Community
About
This repository has all the reused Horusec codes in one place.
Usage
How does DevKit work?
DevKit is the repository where there are some abstractions Horusec's team use to simplify development and testing. For example:
- If you want a code to help you make an HTTP request or if you need a database, you can find it here.
It is reusable codes from other projects, like CLI, Engine, Platform, and Operator. See below DevKit's structure:
Features
Entities
We keep all entities shared by multiple microservices here. For example, analysis and vulnerability structs, which are used from the CLI to the web services.
Enums
Enums refers to all the constants shared between the services. For example, the vulnerability severity is a constant.
Service
You will find here some abstractions from the libraries we use. The difference between service and utils is that here they need an instance or a connection to some requirement. For example, the abstraction of the RabbitMQ library for Go, which simplifies testing and development.
Utils
The utils refer to an abstraction in which instantiation or connection is not necessary. You just need to import and use it, for example, the abstraction from the Logrus library was adapted to make it more comfortable to use.
Documentation
For more information about Horusec, please check out the documentation.
Issues
To open or track an issue for this project, in order to better coordinate your discussions, we recommend that you use the Issues tab in the main Horusec repository.
Contributing
If you want to contribute to this repository, access our Contributing Guide.
Developer Certificate of Origin - DCO
This is a security layer for the project and for the developers. It is mandatory.
Follow one of these two methods to add DCO to your commits:
1. Command line Follow the steps: Step 1: Configure your local git environment adding the same name and e-mail configured at your GitHub account. It helps to sign commits manually during reviews and suggestions.
git config --global user.name “Name”
git config --global user.email “email@domain.com.br”
Step 2: Add the Signed-off-by line with the '-s' flag in the git commit command:
$ git commit -s -m "This is my commit message"
2. GitHub website You can also manually sign your commits during GitHub reviews and suggestions, follow the steps below:
Step 1: When the commit changes box opens, manually type or paste your signature in the comment box, see the example:
Signed-off-by: Name < e-mail address >
For this method, your name and e-mail must be the same registered on your GitHub account.
License
Community
Do you have any question about Horusec? Let's chat in our forum.
This project exists thanks to all the contributors. You rock! ❤️🚀
Directories