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

README: document the security model #183

Merged
merged 7 commits into from
Dec 4, 2021
Merged

README: document the security model #183

merged 7 commits into from
Dec 4, 2021

Conversation

woodruffw
Copy link
Member

@woodruffw woodruffw commented Dec 3, 2021

Closes #181.

@woodruffw woodruffw added the component:docs Documentation components label Dec 3, 2021
@woodruffw woodruffw requested a review from di December 3, 2021 21:51
@woodruffw woodruffw self-assigned this Dec 3, 2021
README.md Outdated
Comment on lines 16 to 22
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Security Model](#security-model)
- [Licensing](#licensing)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
Copy link
Member

Choose a reason for hiding this comment

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

This won't work on PyPI: pypa/readme_renderer#169

Copy link
Contributor

Choose a reason for hiding this comment

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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated

`pip-audit` is a tool for auditing Python environments for packages with
*known vulnerabilities*. A "known vulnerability" is a flaw in a package that,
if uncorrected, *might* allow a malicious actor to perform unintended actions.
Copy link
Member

Choose a reason for hiding this comment

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

...and also has been publicly reported to the project maintainers.

Copy link
Contributor

Choose a reason for hiding this comment

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

README.md Outdated Show resolved Hide resolved
Copy link
Member

@di di left a comment

Choose a reason for hiding this comment

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

LGTM w/ requested changes.

tetsuo-cpp and others added 6 commits December 4, 2021 15:35
Co-authored-by: Dustin Ingram <di@users.noreply.github.com>
Co-authored-by: Dustin Ingram <di@users.noreply.github.com>
Co-authored-by: Dustin Ingram <di@users.noreply.github.com>
@tetsuo-cpp tetsuo-cpp merged commit c792146 into main Dec 4, 2021
@tetsuo-cpp tetsuo-cpp deleted the ww/sec-model branch December 4, 2021 04:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document pip-audit's security model
3 participants