-
Notifications
You must be signed in to change notification settings - Fork 8.6k
Add "Risk Matrix" section to the PR template #100649
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
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
4b8f80c
docs: ✏️ add "Risk Matrix" section to PR template
streamich 0b57013
docs: ✏️ add risk examples
streamich d8adb92
Update RISK_MATRIX.md
streamich 6ad0bc0
Update RISK_MATRIX.md
streamich 94eaa9f
Update RISK_MATRIX.md
streamich c08ac21
Update RISK_MATRIX.md
streamich 0ff8ca4
Update RISK_MATRIX.md
streamich f70d1a1
Update RISK_MATRIX.md
streamich 9be0123
Update RISK_MATRIX.md
streamich 1d7714c
chore: 🤖 make risk matrix .mdx
streamich 8abdf3d
docs: ✏️ improve memory leak bullet point
streamich 7c03ef7
docs: ✏️ improve "Security Risks" section as per review
streamich 37ab7c5
docs: ✏️ encourage to add to the risk list
streamich cd49778
Merge remote-tracking branch 'upstream/master' into risk-matrix
streamich cf9ce73
docs: ✏️ fix link
streamich File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Risk consideration | ||
|
|
||
| When merging a new feature of considerable size or modifying an existing one, | ||
| consider adding a *Risk Matrix* section to your PR in collaboration with other | ||
| developers on your team and the QA team. | ||
|
|
||
| Below are some general themes to consider for the *Risk Matrix*. (Feel free to | ||
| add to this list.) | ||
|
|
||
|
|
||
| ## General risks | ||
|
|
||
| - What happens when your feature is used in a non-default space or a custom | ||
| space? | ||
| - What happens when there are multiple Kibana nodes using the same Elasticsearch | ||
| cluster? | ||
| - What happens when a plugin you depend on is disabled? | ||
| - What happens when a feature you depend on is disabled? | ||
| - Is your change working correctly regardless of `kibana.yml` configuration or | ||
| UI Setting configuration? (For example, does it support both | ||
| `state:storeInSessionStorage` UI setting states?) | ||
| - What happens when a third party integration you depend on is not responding? | ||
| - How is authentication handled with third party services? | ||
| - Does the feature work in Elastic Cloud? | ||
| - Does the feature create a setting that needs to be exposed, or configured | ||
| differently than the default, on the Elastic Cloud? | ||
| - Is there a significant performance impact that may affect Cloud Kibana | ||
| instances? | ||
| - Does your feature need to be aware of running in a container? | ||
| - Does the feature Work with security disabled, or fails gracefully? | ||
| - Are there performance risks associated with your feature? Does it potentially | ||
| access or create: (1) many fields; (2) many indices; (3) lots of data; | ||
| (4) lots of saved objects; (5) large saved objects. | ||
| - Could this cause memory to leak in either the browser or server? | ||
| - Will your feature still work if Kibana is run behind a reverse proxy? | ||
| - Does your feature affect other plugins? | ||
| - If you write to the file system, what happens if Kibana node goes down? What | ||
| happens if there are multiple Kibana nodes? | ||
| - Are migrations handled gracefully? Does the feature affect old indices or | ||
| saved objects? | ||
| - Are you using any technologies, protocols, techniques, conventions, libraries, | ||
| NPM modules, etc. that may be new or unprecedented in Kibana? | ||
|
|
||
|
|
||
| ## Security risks | ||
|
|
||
| Check to ensure that best practices are used to mitigate common vulnerabilities: | ||
streamich marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - Cross-site scripting (XSS) | ||
| - Cross-site request forgery (CSRF) | ||
| - Remote-code execution (RCE) | ||
| - Server-side request forgery (SSRF) | ||
| - Prototype pollution | ||
| - Information disclosure | ||
| - Tabnabbing | ||
|
|
||
| In addition to these risks, in general, server-side input validation should be | ||
| implemented as strictly as possible. Extra care should be taken when user input | ||
| is used to construct URLs or data structures; this is a common source of | ||
| injection attacks and other vulnerabilities. For more information on all of | ||
| these topics, see [Security best practices][security-best-practices]. | ||
|
|
||
| [security-best-practices]: https://www.elastic.co/guide/en/kibana/master/security-best-practices.html | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.