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

Assessments Listing #206

Closed
6 tasks
TheFoxAtWork opened this issue Jun 17, 2019 · 30 comments
Closed
6 tasks

Assessments Listing #206

TheFoxAtWork opened this issue Jun 17, 2019 · 30 comments
Labels
assessment-process proposed improvements to security assessment process good first issue Good for newcomers help wanted Extra attention is needed inactive No activity on issue/PR

Comments

@TheFoxAtWork
Copy link
Contributor

TheFoxAtWork commented Jun 17, 2019

the joint-review README template needs updated to specify:

  • original issue for assessment,
  • assessment date, and
  • project status at time of assessment (pre-incubation, incubation, sandbox, etc

To Do:

  • Create general README in assessments/projects
  • updated Assessment process to create a README in each project folder
  • Link audits, if occurred, on the project's README

Background/original info:

Description: Recommend creating a Closed Assessments folder in Assessments to organize and store all assessment docs per project
Assessments/Closed Assessments/Project1README.md

Project1README.md lists ticket numbers of the request, dates of the activities, CNCF state at time of assessment, reviewers, project lead, etc. recommendation summary, and links to final report. (think of first glance info of high level info without digging into the final report - report has more details and should be linked to where we store it).

Impact: Provide centralized location for identifying previous projects worked by CNCF Security SIG. Provide high level overview of those previous efforts.

@TheFoxAtWork TheFoxAtWork added the proposal common precursor to project, for discussion & scoping label Jun 17, 2019
@ultrasaurus
Copy link
Member

This is great. Thanks for writing this up! I've been thinking of the process as:

  • requested (issue) ==>
  • active / in-progress / draft ==>
  • completed / done / published

The "assessement" is both an activity and an outcome. After we have finished the activity, then the document is ready and available for people to use in helping them consider whether the project meets their needs... so "closed" doesn't work so well from my perspective.

I will draft a README for in-toto, which may help. The self-assessment just got changed into markdown and so adding README/Summary is next step: https://github.com/cncf/sig-security/tree/master/assessments/projects/in-toto

@hannibalhuang
Copy link
Contributor

I think this will lead to another question on the effective period of one assessment. Say we marked OPA done for assessment, will there be a time we need to re-assess given probably the project has been undergoing changes ? Shall we mark an "effective period" that when that period expires the sig needs to do a update assessment ?

@TheFoxAtWork
Copy link
Contributor Author

I think we should stick to each phase of CNCF model, any changes in the projects status should prompt a review (pre-incubation, incubation to sandbox, sandbox to graduation, and once every yr-two yrs? Or perhaps a review for every major version/release?

@hannibalhuang
Copy link
Contributor

I think we should stick to each phase of CNCF model, any changes in the projects status should prompt a review (pre-incubation, incubation to sandbox, sandbox to graduation, and once every yr-two yrs? Or perhaps a review for every major version/release?

I think this is a great idea to align with CNCF project lifecycle :) Per release might be too much of duplicated work

@ultrasaurus ultrasaurus added the assessment-process proposed improvements to security assessment process label Jun 26, 2019
@ultrasaurus
Copy link
Member

there is an open issue to document the fact that security assessments last for one year and that we plan to do some kind of mini-review of whatever has changed: #152

@ultrasaurus
Copy link
Member

maybe we should have a README in the /assessments/projects/ folder

=> @JustinCappos to resolve when back from vacation

@TheMoxieFox
Copy link

Definitely recommend a README in that folder. Content should include the life expectancy of each assessment as well as kind of assessment based on stage in CNCF.

@ultrasaurus recommend merging this ticket and #152 to cover creation of a README including all of this.

@TheMoxieFox
Copy link

Also create a "unofficial" listing for when vendors or projects come to us with evidence of an audit or outside of CNCF, we can store alongside the "official" listing of what security has done.

@JustinCappos
Copy link
Collaborator

JustinCappos commented Jul 14, 2019 via email

@ultrasaurus
Copy link
Member

related issue: prioritization / intake process guidelines: #281

@ultrasaurus
Copy link
Member

I think it would be great if the TBD README listed the projects that had been audited as well as the assessments. I can't seem to find a list of the CNCF security audits -- anyone have a link to that?

maybe @justincormack @caniszczyk @JustinCappos know where those are listed?

@JustinCappos
Copy link
Collaborator

Okay, we're reaching out to @caniszczyk to get the audit list. Once we have that, I think we can put a table together.

@TheFoxAtWork Do you feel we need to have a separate closed folder? Things don't get merged into here until we have finished, so to me these folders already have the assessments. I'd more like to just surface some metadata from the subfolders to make it easier for people to understand what has happened without opening a ton of READMEs.

#309 I'd like to keep the in-progress items (which are tracked by issues) separate from this so we do not duplicate effort.

Once we're in rough agreement, I can go ahead and make the changes...

@ultrasaurus
Copy link
Member

heard via email from @amye -- she's tracking down list of audits and will add them here

@JustinCappos
Copy link
Collaborator

JustinCappos commented Jan 17, 2020 via email

@lumjjb
Copy link
Contributor

lumjjb commented Mar 3, 2020

With the current project board, should this be resolved? @ultrasaurus @JustinCappos

@TheFoxAtWork
Copy link
Contributor Author

concur with @lumjjb

@ultrasaurus
Copy link
Member

I thought this issue would be resolved with a readme for assessments/projects that linked to assessments as well as audits

@TheFoxAtWork
Copy link
Contributor Author

reading back through the ticket and discussion, want to double check before updating the ticket:

  1. Create general README in (assessments/projects)[https://github.com/cncf/sig-security/tree/master/assessments/projects]
  2. updated Assessment process to create a README in each project folder
  3. Link audits, if occurred, on the project's README

@ultrasaurus @JustinCappos does this work?

@JustinCappos
Copy link
Collaborator

Works for me!

@TheFoxAtWork
Copy link
Contributor Author

updated - over to you @JustinCappos

@stale
Copy link

stale bot commented May 3, 2020

This issue has been automatically marked as inactive because it has not had recent activity.

@stale stale bot added the inactive No activity on issue/PR label May 3, 2020
@ultrasaurus ultrasaurus removed the inactive No activity on issue/PR label May 4, 2020
@ultrasaurus
Copy link
Member

This still needs to happen -- all the projects have READMEs, looks like it is just a matter of linking them via a root README. Anyone could submit the PR for that I think.

Maybe create a separate issue for the audits: and assign to @caniszczyk who was going to dig up that info

@ultrasaurus ultrasaurus added the help wanted Extra attention is needed label May 4, 2020
@TheFoxAtWork
Copy link
Contributor Author

TheFoxAtWork commented Jun 1, 2020

Planning on updating this ticket to rescope based on discussion:

  • Create general README in assessments/projects
  • in assessments/guide update Step 5, task 3 "Project lead prepares a PR to /assessments/project-docs/project-name/" to include a README for the project. README should include link to the original issue for assessment, assessment date, and project status at time of assessment (pre-incubation, incubation, sandbox, etc.).

Audit linking should be a separate ticket
@lumjjb @JustinCappos @ultrasaurus ?

@stale
Copy link

stale bot commented Jul 31, 2020

This issue has been automatically marked as inactive because it has not had recent activity.

@stale stale bot added the inactive No activity on issue/PR label Jul 31, 2020
@lumjjb lumjjb added the good first issue Good for newcomers label Feb 22, 2021
@stale stale bot removed the inactive No activity on issue/PR label Feb 22, 2021
@stale
Copy link

stale bot commented Apr 24, 2021

This issue has been automatically marked as inactive because it has not had recent activity.

@stale stale bot added the inactive No activity on issue/PR label Apr 24, 2021
@TheFoxAtWork
Copy link
Contributor Author

  • assessments/guide

the joint-review README template needs updated to specify:

  • original issue for assessment,
  • assessment date, and
  • project status at time of assessment (pre-incubation, incubation, sandbox, etc

@stale stale bot removed the inactive No activity on issue/PR label May 21, 2021
@TheFoxAtWork TheFoxAtWork removed the proposal common precursor to project, for discussion & scoping label May 21, 2021
@stale
Copy link

stale bot commented Jul 20, 2021

This issue has been automatically marked as inactive because it has not had recent activity.

@stale stale bot added the inactive No activity on issue/PR label Jul 20, 2021
@stale stale bot removed the inactive No activity on issue/PR label Sep 15, 2021
@lumjjb
Copy link
Contributor

lumjjb commented Sep 15, 2021

This is a great first issue for folks that are new!

@stale
Copy link

stale bot commented Nov 15, 2021

This issue has been automatically marked as inactive because it has not had recent activity.

@stale stale bot added the inactive No activity on issue/PR label Nov 15, 2021
@anvega
Copy link
Contributor

anvega commented Jun 20, 2023

Although audits have yet to be checked into this repository as those get merged into the project being audited, we've done a good job of checking in assessments upon completion. We can reconsider later if we want to provide a central repository for all security reports of different projects, whether those are audits or reports.

Closing the issue as the proposed changes were made, and the issue has been stale for a few years.

@anvega anvega closed this as completed Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
assessment-process proposed improvements to security assessment process good first issue Good for newcomers help wanted Extra attention is needed inactive No activity on issue/PR
Projects
None yet
Development

No branches or pull requests

7 participants