Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional HTTP API Endpoints #45

Open
c3rb3ru5d3d53c opened this issue Apr 26, 2022 · 2 comments
Open

Additional HTTP API Endpoints #45

c3rb3ru5d3d53c opened this issue Apr 26, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@c3rb3ru5d3d53c
Copy link
Owner

  • List of API Endpoints
  • Implement the API Endpoints
@c3rb3ru5d3d53c c3rb3ru5d3d53c added this to the v1.1.1 milestone Apr 26, 2022
@c3rb3ru5d3d53c c3rb3ru5d3d53c changed the title blapi container Binlex HTTP API Container (blapi) Apr 26, 2022
@c3rb3ru5d3d53c c3rb3ru5d3d53c added the enhancement New feature or request label Apr 26, 2022
@c3rb3ru5d3d53c
Copy link
Owner Author

c3rb3ru5d3d53c commented Apr 27, 2022

HTTP API Endpoints

/api/<version>/ (prefix)
Done - GET /api/v1/samples/<str:sha256> (download sample)
Done - POST /api/v1/samples/<str:corpus>/<str:mode> (upload sample to sample queue)
Done - GET /api/v1/version (get version of pybinlex)
HEAD /api/v1/samples/<str:corpus>/<str:sha256> (check if sample exist)
POST /api/v1/traits (body contains raw mongodb query)
Done GET /api/v1/samples/corpra (list supported corpra)
Done GET /api/v1/samples/modes (list supported modes)
GET /api/v1/traits/<str:corpus>/<str:sha256> (list of sha256 samples with the same trait)
GET /api/v1/traits/<str:corpus>/<str:tlsh>/<int:distance> (list of sha256 samples with similar traits)
GET /api/v1/samples/<str:corpus>/<str:tlsh>/<int:distance> (list of similar traits)
GET /api/v1/traits/<str:hexstr> (Searching hexadecimal string by hand (de ad be ef), w/ wildcards)
POST /api/v1/traits/<corpus>/<sha256> (create tags a sha256 trait in a specific corpus)
POST /api/v1/samples/<corpus>/<sha256> (create tags sha256 of the sample in the object store)
DELETE /api/v1/traits/<corpus>/<sha256> (delete tag a sha256 trait in a specific corpus)
DELETE /api/v1/samples/<corpus>/<sha256> (delete tags sha256 of the sample in the object store)
DELETE /api/v1/samples/<str:corpus>/<str:mode> (delete sample from a corpus, including all traits)
GET /api/v1/samples/tags/<str:query> (get sample tags from query)
GET /api/v1/traits/tags/<str:query> (get trait tags from query)
GET /api/v1/traits/collect/tags/<str:query> (get all traits based on tag)
GET /api/v1/samples/collect/tags/<str:query> (get all samples based on tag)
POST /api/v1/traits/<str:sha256>/functions/ (specify the function name(s) to add)
DELETE /api/v1/traits/<str:sha256>/functions/ (delete the function name(s) from the trait sha256)

@c3rb3ru5d3d53c
Copy link
Owner Author

Keeping this one open just renaming the issue

@c3rb3ru5d3d53c c3rb3ru5d3d53c modified the milestones: v1.1.1, v1.2.0 May 7, 2022
@c3rb3ru5d3d53c c3rb3ru5d3d53c changed the title Binlex HTTP API Container (blapi) Additional HTTP API Endpoints May 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants