Data

Tools

Indexes

Applications

Experiments

Open Source Science

binaryai

Get results of binaryai.cn using our SDK

https://github.com/binaryai/sdk

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 11 committers (9.1%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Get results of binaryai.cn using our SDK

Basic Info
Statistics
  • Stars: 503
  • Watchers: 16
  • Forks: 73
  • Open Issues: 7
  • Releases: 21
Created almost 6 years ago · Last pushed 7 months ago
Metadata Files
Readme Contributing License Citation

README.md

BinaryAI Python SDK

PUBLISH readthedocs Downloads Gitter

BinaryAI is a binary file security analysis platform. This SDK aims at providing a simple client to upload file and get analysis result. It also works as a demo on calling BinaryAI's GraphQL API directly.

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

Dependency

Python >= 3.9

Download and install

bash python3 -m pip install binaryai

Quick start

See the SDK document for guide.

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:

toml 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.
  3. Li, Zongjie, et al. "Unleashing the power of compiler intermediate representation to enhance neural program embeddings." Proceedings of the 44th International Conference on Software Engineering. 2022.
  4. Wong, Wai Kin, et al. "Deceiving Deep Neural Networks-Based Binary Code Matching with Adversarial Programs." 2022 IEEE International Conference on Software Maintenance and Evolution (ICSME). IEEE, 2022.
  5. Wang, Huaijin, et al. "Enhancing DNN-Based Binary Code Function Search With Low-Cost Equivalence Checking." IEEE Transactions on Software Engineering 49.1 (2022): 226-250.
  6. Jia, Ang, et al. "1-to-1 or 1-to-n? Investigating the Effect of Function Inlining on Binary Similarity Analysis." ACM Transactions on Software Engineering and Methodology 32.4 (2023): 1-26.
  7. Wang, Huaijin, et al. "sem2vec: Semantics-aware Assembly Tracelet Embedding." ACM Transactions on Software Engineering and Methodology 32.4 (2023): 1-34.
  8. Jiang, Ling, et al. "Third-Party Library Dependency for Large-Scale SCA in the C/C++ Ecosystem: How Far Are We?." Proceedings of the 32nd ACM SIGSOFT International Symposium on Software Testing and Analysis. 2023.

Owner

  • Name: BinaryAI
  • Login: binaryai
  • Kind: organization
  • Email: binaryai@tencent.com

The Neural Search Engine for Binaries

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: BinaryAI
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - name: Tencent Security Keen Lab
    website: 'https://keenlab.tencent.com'
    email: KeenSecurityLab@tencent.com
url: 'https://www.binaryai.cn'
date-released: '2021-08-11'

GitHub Events

Total
  • Release event: 4
  • Watch event: 14
  • Delete event: 3
  • Issue comment event: 3
  • Push event: 5
  • Pull request review event: 1
  • Pull request event: 7
  • Create event: 11
Last Year
  • Release event: 4
  • Watch event: 14
  • Delete event: 3
  • Issue comment event: 3
  • Push event: 5
  • Pull request review event: 1
  • Pull request event: 7
  • Create event: 11

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 110
  • Total Committers: 11
  • Avg Commits per committer: 10.0
  • Development Distribution Score (DDS): 0.755
Top Committers
Name Email Commits
nforest n****t@o****m 27
DogeWatch D****h@u****m 25
snie s****e@t****m 24
Lavender Tree 4****n@u****m 11
UESuperGate 4****e@u****m 8
Daven Du d****u@t****m 4
ltchen l****n@t****m 4
dodgetang d****g@t****m 3
Michelle h****i@s****n 2
Marco Grassi m****a@g****m 1
MatthewShao me@m****m 1
Committer Domains (Top 20 + Academic)
tencent.com: 4 matshao.com: 1 sjtu.edu.cn: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 17
  • Total pull requests: 110
  • Average time to close issues: 5 months
  • Average time to close pull requests: 18 days
  • Total issue authors: 15
  • Total pull request authors: 9
  • Average comments per issue: 3.18
  • Average comments per pull request: 0.22
  • Merged pull requests: 72
  • Bot issues: 0
  • Bot pull requests: 25
Past Year
  • Issues: 1
  • Pull requests: 13
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 months
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.31
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 13
View more stats
Top Authors
Issue Authors
  • Xelawk (2)
  • island255 (2)
  • wangyongpang (1)
  • sst4rb0y (1)
  • liquan165 (1)
  • shiraishi-mai (1)
  • hxl13579 (1)
  • VictoriaChou (1)
  • szlenghuangfei (1)
  • WinMin (1)
  • Altonhe (1)
  • 490694561 (1)
  • Adalsteinnjons (1)
  • whbjzzwjxq (1)
  • Lost-little-dinosaur (1)
Pull Request Authors
  • dependabot[bot] (38)
  • agfn (25)
  • UESuperGate (19)
  • nforest (19)
  • DogeWatch (13)
  • davendu (5)
  • michellehong (3)
  • MatthewShao (1)
  • marcograss (1)
Top Labels
Issue Labels
bug (2)
Pull Request Labels
dependencies (38) python (9) documentation (1) bug (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 213 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 21
  • Total maintainers: 1
pypi.org: binaryai

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

  • Versions: 21
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 213 Last month
Rankings
Stargazers count: 2.9%
Forks count: 5.0%
Dependent packages count: 10.1%
Average: 12.1%
Downloads: 21.0%
Dependent repos count: 21.5%
Maintainers (1)
BinaryAI
Last synced: 6 months ago

Dependencies

.github/workflows/linter.yml actions
  • abatilo/actions-poetry v2 composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
.github/workflows/publish.yml actions
  • abatilo/actions-poetry v2 composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
.devcontainer/Dockerfile docker
  • mcr.microsoft.com/devcontainers/python 1-3.9-bullseye build
poetry.lock pypi
  • 117 dependencies
pyproject.toml pypi
  • ariadne-codegen ^0.9.0 develop
  • black 22.6.0 develop
  • flake8 4.0.1 develop
  • isort 5.10.1 develop
  • pytest ^7.4.2 develop
  • ipykernel ^6.25.2 docs
  • myst-parser ^2.0.0 docs
  • nbsphinx ^0.9.3 docs
  • sphinx ^7.2.6 docs
  • sphinx-autoapi ^2.1.1 docs
  • sphinx-intl ^2.1.0 docs
  • sphinx-rtd-theme ^1.3.0 docs
  • deprecated ^1.2.14
  • httpx ^0.25.0
  • pydantic ^2.3.0
  • python ^3.9