OWASP / www-project-integration-standards

OWASP Foundation Web Respository
27 stars 16 forks source link

CRE Inventory Structure Proposal #18

Closed ThunderSon closed 3 years ago

ThunderSon commented 4 years ago

In order to properly implement CRE, I was thinking of a structure that could work as the database of the inventory, and as such I thought of using a github repository with a combination of folders (more files for linux diehards) and files. Below is a sample:

.
└── cre
    ├── cre_relevant_details
    │   ├── metadata.md
    │   ├── requirements
    │   │   ├── asvs.md
    │   │   └── pcidss.md
    │   └── tests
    │       ├── mstg.md
    │       └── wstg.md
    └── cre_second_requirement

metadata.md will be explained better after Wednesday. It will contain metadata for the CRE that is being tackled. asvs.md contains:

[asvs-ref-1](https://asvs-ref-1/)
[asvs-ref-2](https://asvs-ref-2/)

This could change definitely on what we could see as essential for the repository. Awaiting your feedback.

Update 1: As a starting point, the metadata file could simply contain:

As the project grows, the metadata can start to contain ratings, comments, whatever we see as fit to serve the community better.

As for the structure, Rob provided a suggestion to be discussed. Instead of having requirements, tests, etc. under each CRE, we can have a definition file that contains what asvs is, what pcidss is, and then at render time they will get mapped accordingly.