Skip to content

Commit

Permalink
Merge pull request Be-Secure#9 from asa1997/main
Browse files Browse the repository at this point in the history
Updated purpose for poi and schema for lab
  • Loading branch information
harimohanr authored Feb 7, 2024
2 parents efe7c98 + bbb4123 commit dd80db0
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 13 deletions.
23 changes: 19 additions & 4 deletions docs/lab-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,8 @@ contain UTF-8 text.
```json
{
"schema_version": "STRING",
"id": "STRING",
"name": "STRING",
"version": {
"tag": "STRING",
"release_date": "STRING"
},
"description": "STRING",
"owner":{
"name": "STRING",
Expand All @@ -43,6 +40,23 @@ contain UTF-8 text.
"date_of_creation": "STRING",
"modified_date": "STRING",
"size": "STRING",
"poi": "NUMBER",
"voi": "NUMBER",
"moi": "NUMBER",
"tools":[
{
"type": "STRING",
"name": "STRING",
"version": "STRING"
}
],
"datastore": [
{
"type": "STRING",
"scope": "STRING",
"path": "STRING"
}
],
"instances": [
{
"id": "STRING",
Expand All @@ -54,6 +68,7 @@ contain UTF-8 text.

}
```

# Field Details

## schema_version field
Expand Down
20 changes: 11 additions & 9 deletions docs/poi-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@ nav_order: 2
Original authors:
- Vinod Panicker (@panickervinod)
- Harimohan Rajamohanan (@harimohanr)
- Arun Suresh (@asa1997 )
- Arun Suresh (@asa1997)
- Sudhir Verma(@sudhirverma)

# Purpose

This document defines the data interchange format for open source software projects of Interest (OSSPOI) for any given organisation . An organization powered by BeSLab shall publish their OSSPoI to its peers as well the community dashboard BeSLighthouse.
This format is stable, but further backwards compatible changes may still be made.
Feedback from maintainers of other vulnerability databases and security response teams
is most welcome. Please feel free to create an [issue in this repo](https://github.com/Be-Secure/bes-schema/issues/new).
This document outlines a standardized data interchange format for open source software projects of interest (OSSPoI) within organizations. The OSSPoI encompasses essential project details such as project **id**, project **name**, **version** specifics, **owner** information, **onboarded_date**, and **last_update_date**. These details facilitate seamless sharing among peers within the organization and publication to the BeSLighthouse community dashboard. Open Source projects can be onbaorded into BeSLab by BLIman utility.

This standardized data interchange format not only streamlines the sharing and publication process of open source software projects within organizations but also significantly reduces the time required for BeSLabs to assess projects of interest. By providing a structured framework for exchanging essential project details, BeSLabs can expedite their assessment procedures and evaluation of open source projects.

This format is stable, but further backwards compatible changes may still be made. Please feel free to create an [issue in this repo](https://github.com/Be-Secure/bes-schema/issues/new).

# Format Overview

Expand Down Expand Up @@ -52,7 +54,7 @@ A sample json for your understanding is available
"issue_url": "STRING",
"description": "STRING",
"bes_technology_stack": "STRING",
"onboard_date": "STRING",
"onboarded_date": "STRING",
"last_update_date": "STRING",
"forked_repo_url": "STRING",
"tavoss_repo_url": "STRING",
Expand Down Expand Up @@ -197,14 +199,14 @@ A small description about the project.
```
The category under which the project belong.

## projects.onboard_date
## projects.onboarded_date

```json
{
"onboard_date": "STRING"
"onboarded_date": "STRING"
}
```
Date and time at which the project repo was created.
Date and time at which the project was onboarded.

## projects.last_update_date

Expand Down

0 comments on commit dd80db0

Please sign in to comment.