github.com/HXSecurity/DongTai-agent-go@v0.4.2/README.md (about)

     1  ## DongTai-agent-go
     2  ---
     3  [中文文档](README_zh.md)
     4  
     5  [![license Apache-2.0](https://img.shields.io/github/license/HXSecurity/DongTai-agent-go)](https://github.com/HXSecurity/DongTai-agent-go/blob/main/LICENSE)
     6  [![GitHub stars](https://img.shields.io/github/stars/HXSecurity/DongTai-agent-go.svg?label=Stars&logo=github)](https://github.com/HXSecurity/DongTai-agent-go)
     7  [![GitHub forks](https://img.shields.io/github/forks/HXSecurity/DongTai-Agent-Go?label=Forks&logo=github)](https://github.com/HXSecurity/DongTai-agent-go)
     8  [![GitHub Contributors](https://img.shields.io/github/contributors-anon/HXSecurity/DongTai-agent-go?label=Contributors&logo=github)](https://github.com/HXSecurity/DongTai-agent-go)
     9  
    10  [![Github Version](https://img.shields.io/github/v/release/HXSecurity/DongTai-agent-go?display_name=tag&include_prereleases&sort=semver)](https://github.com/HXSecurity/DongTai-agent-go/releases)
    11  [![Release downloads](https://shields.io/github/downloads/HXSecurity/DongTai-Agent-go/total)](https://github.com/HXSecurity/DongTai-agent-go/releases)
    12  
    13  
    14  
    15  
    16  ## Project Introduction
    17  
    18  DongTai-agent-go is the data collection terminal developed by **Dongtai IAST** for Go applications. In the Go application with the iast-agent agent, the required data is collected by rewriting the assembly address, and then the data is sent to the DongTai-openapi service, and the cloud engine processes the data to determine whether there are security vulnerabilities.
    19  
    20  DongTai-agent-go is composed of three main parts: `core`, `run`, and `service`, among which:
    21  
    22  `run` is used to run the agent of the package that needs to be instrumented on demand
    23  
    24  `core` is the core package, and its main functions are: bytecode instrumentation, data collection, data preprocessing, data reporting, third-party component management, etc.
    25  
    26  `service` is used to obtain the request sent by the application and the response received, for data display and request replay function.
    27  
    28  ## Application scenario
    29  
    30  DevOps process
    31  
    32  Safety test before going live
    33  
    34  Third-party component management
    35  
    36  Code audit
    37  
    38  0 Day mining
    39  
    40  ## Get started quickly
    41  
    42  ### Quick use
    43  
    44  Please refer to: [Quick Start](https://doc.dongtai.io)
    45  
    46  ### Rapid development
    47  
    48  1. Fork [DongTai-agent-go](https://github.com/HXSecurity/DongTai-agent-go) project to your github repository and clone the project:
    49  
    50     ```shell
    51     git clone https://github.com/<your-username>/DongTai-agent-go
    52     ```
    53  
    54  2. Write code according to requirements
    55  
    56  3. Contribute code. If you want to contribute code to the Dongtai IAST team, please read the complete [Contribution Guide](https://github.com/HXSecurity/DongTai/blob/main/CONTRIBUTING.md)
    57  
    58  #### Supported Go versions and middleware
    59  
    60  Go 1.11+
    61  
    62  Gin, Gorm and other mainstream software and middleware