tag-security icon indicating copy to clipboard operation
tag-security copied to clipboard

Assessments Listing

Open TheFoxAtWork opened this issue 5 years ago • 29 comments

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 avatar Jun 17 '19 17:06 TheFoxAtWork

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

ultrasaurus avatar Jun 18 '19 15:06 ultrasaurus

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 ?

hannibalhuang avatar Jun 20 '19 13:06 hannibalhuang

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?

TheFoxAtWork avatar Jun 20 '19 15:06 TheFoxAtWork

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

hannibalhuang avatar Jun 21 '19 02:06 hannibalhuang

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: https://github.com/cncf/sig-security/issues/152

ultrasaurus avatar Jul 02 '19 02:07 ultrasaurus

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

=> @JustinCappos to resolve when back from vacation

ultrasaurus avatar Jul 02 '19 02:07 ultrasaurus

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 avatar Jul 03 '19 17:07 TheMoxieFox

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.

TheMoxieFox avatar Jul 03 '19 17:07 TheMoxieFox

Given I'm conflicted with in-toto, I'm probably not the right person to write the document for it. However, I can do the OPA one.

On Wed, Jul 3, 2019 at 1:52 PM Emily The Moxie Fox [email protected] wrote:

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.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/cncf/sig-security/issues/206?email_source=notifications&email_token=AAGROD3FNVX5XXGS62T7P3LP5TRMBA5CNFSM4HYYZETKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZFGXAI#issuecomment-508193665, or mute the thread https://github.com/notifications/unsubscribe-auth/AAGROD5VZU45NRDWLFJGQILP5TRMBANCNFSM4HYYZETA .

JustinCappos avatar Jul 14 '19 12:07 JustinCappos

related issue: prioritization / intake process guidelines: https://github.com/cncf/sig-security/issues/281

ultrasaurus avatar Oct 01 '19 15:10 ultrasaurus

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?

ultrasaurus avatar Nov 20 '19 23:11 ultrasaurus

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...

JustinCappos avatar Dec 15 '19 15:12 JustinCappos

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

ultrasaurus avatar Dec 18 '19 04:12 ultrasaurus

Looking forward to seeing this. I know several folks have been looking for such a resource...

On Tue, Dec 17, 2019 at 11:33 PM Sarah Allen [email protected] wrote:

heard via email from @amye https://github.com/amye -- she's tracking down list of audits and will add them here

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/cncf/sig-security/issues/206?email_source=notifications&email_token=AAGROD7JAH4G3AUHP5KSFVDQZGR3NA5CNFSM4HYYZETKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHE2KQQ#issuecomment-566863170, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAGROD3LNCID2SPC7SXAS5DQZGR3NANCNFSM4HYYZETA .

JustinCappos avatar Jan 17 '20 15:01 JustinCappos

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

lumjjb avatar Mar 03 '20 14:03 lumjjb

concur with @lumjjb

TheFoxAtWork avatar Mar 03 '20 17:03 TheFoxAtWork

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

ultrasaurus avatar Mar 04 '20 04:03 ultrasaurus

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?

TheFoxAtWork avatar Mar 04 '20 12:03 TheFoxAtWork

Works for me!

JustinCappos avatar Mar 04 '20 14:03 JustinCappos

updated - over to you @JustinCappos

TheFoxAtWork avatar Mar 04 '20 15:03 TheFoxAtWork

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

stale[bot] avatar May 03 '20 15:05 stale[bot]

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 avatar May 04 '20 00:05 ultrasaurus

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 ?

TheFoxAtWork avatar Jun 01 '20 14:06 TheFoxAtWork

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

stale[bot] avatar Jul 31 '20 15:07 stale[bot]

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

stale[bot] avatar Apr 24 '21 14:04 stale[bot]

  • 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

TheFoxAtWork avatar May 21 '21 13:05 TheFoxAtWork

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

stale[bot] avatar Jul 20 '21 17:07 stale[bot]

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

lumjjb avatar Sep 15 '21 19:09 lumjjb

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

stale[bot] avatar Nov 15 '21 16:11 stale[bot]

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 avatar Jun 20 '23 01:06 anvega