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

Add DevSecOps documentation and guidance #436

Merged
merged 15 commits into from
May 12, 2021

Conversation

LizaShak
Copy link
Contributor

@LizaShak LizaShak commented Dec 2, 2020

Changes introduced in this PR:

  1. Introducing documentation on DevOps Security (DevSecOps) best practices, information and tools for application.
  2. Updating the existing Credential Scanning documentation to follow the same template.
  3. Linking to DevSecOps section in other relevant documentations.

Copy link
Member

@TessFerrandez TessFerrandez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great add to the playbook, very useful content

@DariuszPorowski
Copy link
Member

Hey @LizaShak Just started review.

Copy link
Member

@DariuszPorowski DariuszPorowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@LizaShak I have only 1 feedback item, aligned with @seushermsft.

Copy link
Member

@DariuszPorowski DariuszPorowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

Copy link
Contributor

@brockneedscoffee brockneedscoffee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really great content. The Microsoft repo links should probably be removed though since folks who are not part of the Microsoft org cannot access it and this is intended for use outside of Microsoft (e.g. CSE customers, open source community, etc)


## Dependency and Container Scanning Frameworks and Tools

Use the tools and pipelines as suggested in [CSEDevSecOps Dependency and Container Scanning Scenarios](https://github.com/microsoft/CSEDevSecOps/tree/master/Scenarios/DependencyContainerScanning).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given this is an open source playbook that we share with our customers and those outside Microsoft I don't think we should include this link. It is not accessible by people who are not part of the Microsoft org, it 404s.

# Penetration Testing

A penetration test is a simulated attack against your application to check for exploitable security issues.
For further reading see [CSEDevSecOps PenetrationTesting Scenarios](https://github.com/microsoft/CSEDevSecOps/tree/master/Scenarios/PenetrationTesting)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given this is an open source playbook that we share with our customers and those outside Microsoft I don't think we should include this link. It is not accessible by people who are not part of the Microsoft org, it 404s.

## The concept of DevSecOps

DevSecOps or DevOps security is about introducing security earlier in the life cycle of application development (a.k.a shift-left), thus minimizing the impact of vulnerabilities and bringing security closer to development team.
Further information is available [here](https://github.com/microsoft/CSEPackagedSprints/tree/master/DevSecOps).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given this is an open source playbook that we share with our customers and those outside Microsoft I don't think we should include this link. It is not accessible by people who are not part of the Microsoft org, it 404s.

## CSE Packaged Sprints

DevOps, Identity, and Security have standard foundational requirements across Dev Crew projects. The CSE Packaged sprints are set out to tackle this repetitive work. Adding a packaged sprint offers a pathway to dramatically improve the process of incorporating foundational concepts.
Further information is available [here](https://github.com/microsoft/CSEPackagedSprints).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

404s unless you are part of the Microsoft org in GitHub


## Resources

[CSEDevSecOps Scenarios](https://github.com/microsoft/CSEDevSecOps/tree/master/Scenarios)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

404s unless you are part of the Microsoft org in GitHub

# Credential Scanning

Credential scanning is the practice of automatically inspecting a project to ensure that no secrets are included in the project's source code. Secrets include database passwords, storage connection strings, admin logins, service principals, etc.
For further reading see [CSEDevSecOps Credential Scanning Scenarios](https://github.com/microsoft/CSEDevSecOps/tree/master/Scenarios/CredentialScanning).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

404s unless you are part of the Microsoft org in GitHub

@brockneedscoffee
Copy link
Contributor

@LizaShak is there an update on this? Do you need some assistance?

@LizaShak
Copy link
Contributor Author

LizaShak commented Apr 19, 2021

@LizaShak is there an update on this? Do you need some assistance?

Hi @brockneedscoffee , we have checked with CSE DevSecOps team to see if those links will be public soon, and they won't in the near two months. So I am currently working on replacing those links with the relevant information.

@fnocera
Copy link
Contributor

fnocera commented Apr 20, 2021

Once #607 is merged in all outstanding PRs including this one will have to make a few changes and merge master to adopt the new MKDocs structure. This main change is that all the md files move into a docs folder, not on the root of the repo.
If you'd like to test the website locally:

  1. Create a virtual Python env
  2. Install the dependencies ( pip install -r requirements-docs.txt )
  3. Run mkdocs serve

Please don't hesitate to reach out with any questions and a number of us are more than happy to help with this process - reach out to @fnocera @TessFerrandez @omri374 and @brockneedscoffee

@brockneedscoffee brockneedscoffee self-assigned this Apr 21, 2021
@brockneedscoffee brockneedscoffee self-requested a review May 12, 2021 13:11
@brockneedscoffee brockneedscoffee merged commit fe4cafb into microsoft:main May 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD CI/CD topic security Security topic
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants