topscrew / dongtai-openapi

DongTai-openapi is used to process probe registration, issue hook strategies, receive method call data/component data/error log/heartbeat data, issue vulnerability detection tasks, issue packet replay data, etc.

DongTai-openapi

中文版本(Chinese version)

Whit is DongTai-Engine?

DongTai-OpenAPI is used to process DongTai probe related requests, including:

• Process agent registration request
• Processing heartbeat data
• Processing error log data
• Processing third-party component data
• Processing method call data
• Processing authority registration/change and other data
• Send probe control commands
• Send hook strategy
• Download detection engine, etc.

Deploy

Basic services：MySql、DongTai-Engine

The basic service configuration is as follows：

service name	ip	port	additional
MySql	127.0.0.1	3306	account：dongtai password：dongtai-iast database name：dongtai_webapi
DongTai-Engine	127.0.0.1	8081

Official image

1. Pull image

$ docker pull registry.cn-beijing.aliyuncs.com/huoxian_pub/dongtai-openapi:1.0.0

2. Create a configuration file：/etc/dongtai/config.ini，The content is as follows：

[mysql]
host = 127.0.0.1
port = 3306
name = dongtai_webapi
user = dongtai
password = dongtai-iast

[redis]
host = redis
port = port
password = password
db = 0


[engine]
url = http://127.0.0.1:8081

; The following content unused, keep the default
[apiserver]
url = http://api_server_url

[smtp]
server = server
user = user
password = password
from_addr = from_addr
ssl = False
cc_addr = cc_addr

[aliyun_oss]
access_key = access_key
access_key_secret = access_key

3. Start the dongtai-openapi container and map the configuration file

$ docker run -d --name dongtai-openapi -p 8000:8000 -v /etc/dongtai/config.ini:/opt/dongtai/openapi/conf/config.ini --restart=always huoxian_pub/dongtai-openapi:1.0.0

Build custom image

1. Build image

$ docker build -t huoxian_pub/dongtai-openapi:1.0.0 .

2. Create a configuration file：/etc/dongtai/config.ini，The content is as follows：

[mysql]
host = 127.0.0.1
port = 3306
name = dongtai_webapi
user = dongtai
password = dongtai-iast

[redis]
host = redis
port = port
password = password
db = 0


[engine]
url = http://127.0.0.1:8081

; The following content unused, keep the default
[apiserver]
url = http://api_server_url

[smtp]
server = server
user = user
password = password
from_addr = from_addr
ssl = False
cc_addr = cc_addr

[aliyun_oss]
access_key = access_key
access_key_secret = access_key

3. Start the dongtai-openapi container and map the configuration file

$ docker run -d --name dongtai-openapi -p 8000:8000 -v /etc/dongtai/config.ini:/opt/dongtai/openapi/conf/config.ini --restart=always huoxian_pub/dongtai-openapi:1.0.0

Contributing

Contributions are welcomed and greatly appreciated. See CONTRIBUTING.md for details on submitting patches and the contribution workflow.

Any questions? Let's discuss in #DongTai discussions

More resources

• Documentation
• DongTai WebSite