binaryai 0.7.0a2

BinaryAI-SDK is a library provides an abstracted client module to simplify the procedure of uploading file for analysis.

BinaryAI Python SDK

BinaryAI is a binary file security analysis platform. This SDK aims at providing a simple client to upload file and get analysis result. It can also works as a demo on calling BinaryAI's GraphQL API directly. The Python3 SDK for BinaryAI provides an abstracted client module to simplify the procedure of uploading file for analysis.

To use SDK, you need a valid credentials. Read BinaryAI docs about detailed instructions.

Dependency

Python >= 3.9

Download and installation

python3 -m pip install binaryai

Contributing

See CONTRIBUTING.md.

Internals

Endpoints

The default endpoint is https://api.binaryai.cn/v1/endpoint.

API Credentials

API Credentials are used for signing requests. We suggest you using our SDK or our library to sign it, but you can also have your own implementation. We are using the signing method TC3-HMAC-SHA256, same with the Tencent Cloud. You can read their document about how to sign requests. BinaryAI would require following fields:

Region  = "ap-shanghai"
service = "binaryai"
Action  = "BinaryAI"
Version = "2023-04-15"

Additional Reading

Read the Changelog of our product, and hope you can also have fun reading papers related to our job:

1. Yu, Zeping, et al. "Codecmr: Cross-modal retrieval for function-level binary source code matching." Advances in Neural Information Processing Systems 33 (2020): 3872-3883.
2. Yu, Zeping, et al. "Order matters: Semantic-aware neural networks for binary code similarity detection." Proceedings of the AAAI conference on artificial intelligence. Vol. 34. No. 01. 2020.