diff --git a/README.md b/README.md index f2e92c90cc..c205721f23 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ identify risks in generative AI systems. - Check out our [website](https://microsoft.github.io/PyRIT/) for more information about how to use, install, or contribute to PyRIT. +- Review our [security policy](https://github.com/microsoft/PyRIT/security/policy) + to report vulnerabilities privately through the Microsoft Security Response Center. - Visit our [Discord server](https://discord.gg/9fMpq3tc8u) to chat with the team and community. ## Trademarks and Citations diff --git a/doc/contributing/10_release_process.md b/doc/contributing/10_release_process.md index 4637b9b5cd..996362a16e 100644 --- a/doc/contributing/10_release_process.md +++ b/doc/contributing/10_release_process.md @@ -11,6 +11,46 @@ Follow the instructions according to the order provided. Before starting the release process, verify the codebase is in a healthy state. +### Customer-Facing Review + +Use an existing release work item, or create one if none exists, to track release +readiness. The release owner reviews the customer-facing release materials: draft +GitHub release notes, changed public documentation, and changed CoPyRIT UI content. +Review the changed documentation and UI content for technical accuracy, security and +compatibility disclosures, content clarity, and usability. Ensure the release notes +include: + +- A summary of the important bug fixes and features being shipped. +- Security fixes and known high-priority security issues, including affected versions + and recommended actions. If there are none, write + `No known high-priority security issues.` +- Breaking changes and backward-compatibility issues, including clear migration or + mitigation steps. If there are none, write + `No known breaking changes or backward-compatibility issues.` + +Link the draft release notes in the release work item. Record +`Initial review completed by @owner on YYYY-MM-DD: no findings` or link the issues or +pull requests that resolved the findings. + +#### Before Publishing + +A PyRIT maintainer other than the release owner reviews the final materials and: + +1. Compares the final release notes with the changes included in the release and + confirms that the required content is complete and accurate. +2. Opens the changed documentation and applicable CoPyRIT UI to confirm that the + content is clear, security information is accessible, and the final materials match + the release notes. +3. Confirms that high-priority security bugs and technical-review findings from the + initial review are resolved. +4. Records either + `Approved by @reviewer on YYYY-MM-DD for development, security, content, and UX` + or the remaining changes required before approval in the release work item. + +Do not include details about security vulnerabilities that have not yet been publicly +disclosed in the release work item. Follow [the security policy](../../SECURITY.md) +for private vulnerability reporting. + - **Check for pending changes.** Ask other PyRIT maintainers whether they have any in-flight changes that should land before the release. - **Verify build pipelines.** Confirm that all integration tests and end-to-end tests are passing in the CI pipelines. If any tests are failing, fix them before proceeding. - **Partner integration tests.** Ensure the partner integration tests are also passing. These tests validate that we are not breaking contracts with partner teams (e.g., Foundry). If any are failing, coordinate with the affected partner teams before proceeding with the release. @@ -254,6 +294,15 @@ since `downgrade()` risks data loss. ## 10. Publish to PyPI +Complete this checklist in the release work item: + +- [ ] The initial review is recorded, and the draft release notes are linked. +- [ ] High-priority security bugs and technical-review findings are resolved. +- [ ] A maintainer other than the release owner has recorded final approval for development, security, content, and UX. +- [ ] Release notes contain the required security and compatibility disclosures. + +Do not publish the package until every item is complete. + Create an account on pypi.org if you don't have one yet. Ask one of the other maintainers to add you to the `pyrit` project on PyPI. @@ -283,18 +332,15 @@ This should be something like `x.y.z+1.dev0`. ## 12. Create GitHub Release -Finally, go to the [releases page](https://github.com/microsoft/PyRIT/releases), select "Draft a new release" and the "tag" -for which you want to create the release notes. It should match the version that you just released -to PyPI. Hit "Generate release notes". This will pre-populate the text field with all changes. -Make sure that it starts where the last release left off. -Sometimes this tool adds too many changes, or leaves a few out, so it's best to check. -Be sure to check and update the new contributors as well. -Add a header "## Full list of changes" below "## What's changed?". -In addition to the full notes, we also want a shorter section with just the relevant -changes that users should be aware of. The shorter section will be under "## What's changed" -while the full list of changes will be right below. -Maintenance changes, build pipeline updates, and documentation fixes are not really important for users. -However, important bug fixes, new features, and breaking changes are good candidates to include. +Finally, go to the [releases page](https://github.com/microsoft/PyRIT/releases), select +"Draft a new release", and choose the tag that matches the version published to PyPI. +Generate the release notes to produce the full change list. Verify that the list starts +where the previous release ended and that the new-contributor list is accurate. Add +"## Full list of changes" below "## What's changed" and place the generated list +there. Use the approved release notes linked from the release work item for +"## What's changed". Maintenance changes, build pipeline updates, and routine +documentation fixes can remain in the full list only. + If you are unsure about whether to include certain changes please consult with your fellow maintainers. When you're done, hit "Publish release" and mark it as the latest release. diff --git a/doc/myst.yml b/doc/myst.yml index 374ac62039..5b192d30b0 100644 --- a/doc/myst.yml +++ b/doc/myst.yml @@ -39,6 +39,7 @@ project: - "https://www.youtube.com/watch?v=jq9DcEL3cHE" toc: - file: index.md + - file: security.md - file: getting_started/README.md children: - file: getting_started/install.md diff --git a/doc/security.md b/doc/security.md new file mode 100644 index 0000000000..7182ec913a --- /dev/null +++ b/doc/security.md @@ -0,0 +1,14 @@ +# Security + +Microsoft takes the security of PyRIT seriously. + +If you believe you have found a security vulnerability, **do not report it through a +public GitHub issue**. Submit it privately to the +[Microsoft Security Response Center](https://aka.ms/security.md/msrc/create-report). +The repository's [security policy](https://github.com/microsoft/PyRIT/security/policy) +describes alternative reporting methods, the information to include, and Microsoft's +coordinated vulnerability disclosure policy. + +Review the [PyRIT release notes](https://github.com/microsoft/PyRIT/releases) for +customer-facing security notices, known high-priority security issues, breaking +changes, and compatibility guidance for each release. diff --git a/frontend/src/components/Sidebar/Navigation.test.tsx b/frontend/src/components/Sidebar/Navigation.test.tsx index e25de60a5f..25a4ad45d6 100644 --- a/frontend/src/components/Sidebar/Navigation.test.tsx +++ b/frontend/src/components/Sidebar/Navigation.test.tsx @@ -96,6 +96,15 @@ describe("Navigation", () => { expect(onOpenFeedback).toHaveBeenCalledTimes(1); }); + it("links to the public security policy", () => { + renderWithProvider(); + + expect(screen.getByRole("link", { name: "Security" })).toHaveAttribute( + "href", + "https://github.com/microsoft/PyRIT/security/policy" + ); + }); + it("calls onNavigate with 'history' when history button is clicked", async () => { const user = userEvent.setup(); const onNavigate = jest.fn(); diff --git a/frontend/src/components/Sidebar/Navigation.tsx b/frontend/src/components/Sidebar/Navigation.tsx index cf4a1dfc63..12ad9dd133 100644 --- a/frontend/src/components/Sidebar/Navigation.tsx +++ b/frontend/src/components/Sidebar/Navigation.tsx @@ -13,6 +13,7 @@ import { SettingsRegular, HistoryRegular, PersonFeedbackRegular, + OpenRegular, WeatherMoonRegular, WeatherSunnyRegular, } from '@fluentui/react-icons' @@ -106,6 +107,17 @@ export default function Navigation({ currentView, onNavigate, onOpenFeedback }: aria-label="Feedback" onClick={onOpenFeedback} /> +