Create an API endpoint which given a Standard JSON, suggests which CREs are the most likely mappings for this standard section
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 180
- Forks
- 137
- Avg merge
- 3d 23h
- Merged PRs (30d)
- 21
Description
As an opencre or standard maintainer, I want to be able to import new standards or other security information very quickly in the CRE graph.
Given I have this information in a CRE Standard format, I need to find which CRE is best suited for linking with a specific section of my standard.
In order to do that I need an API call POST opencre.org/rest/v1/link/suggest where the body of the api call is a CRE Standard in json format.
OpenCRE then needs to reply with a json array of CREs that are best suited to match my standard.
e.g.
POST opencre.org/rest/v1/link/suggest
{"doctype":"Standard","hyperlink":"https://github.com/OWASP/ASVS/blob/v4.0.2/4.0/en/0x11-V2-Authentication.md","links":[],"name":"ASVS","section":"Verify that the challenge nonce is at least 64 bits in length, and statistically unique or unique over the lifetime of the cryptographic device.","sectionID":"V2.9.2"}]
Response:
[{"doctype":"CRE","id":"287-251","name":"Use a unique challenge nonce of sufficient size","tags":["Cryptography"]},{"doctype":"CRE","id":"287-252","name":"Some other CRE","tags":["Cryptography"]}]
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the CRE Standard definition in application/defs/cre_defs.py and reviewing the requested POST endpoint at opencre.org/rest/v1/link/suggest. Use the supplied ASVS example to understand the request and response shapes; done means the endpoint accepts a CRE Standard JSON document and returns an array of likely CRE mappings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100