-
Notifications
You must be signed in to change notification settings - Fork 97
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
SDK-4093. Added Security update checker doc #2066
Merged
AlexSlawinski
merged 3 commits into
master
from
feature/sdk-4093-security-update-checker
Aug 3, 2023
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
44 changes: 44 additions & 0 deletions
44
...elines/keeping-a-project-upgradable/upgradability-guidelines/security-update.md
This file contains 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,44 @@ | ||
--- | ||
title: Security update checker | ||
description: Reference information for evaluator tools. | ||
template: howto-guide-template | ||
--- | ||
|
||
Security Update Checker is a tool that checks if security fixes exist for Spryker modules that are present in your project. | ||
|
||
## Problem description | ||
|
||
A project can sometimes use dependencies that contain known vulnerabilities. To minimize the security risk for the project, such dependencies should be updated to the version that has the vulnerability fixed. | ||
|
||
## Example of an evaluator error message | ||
|
||
```bash | ||
======================= | ||
SECURITY UPDATE CHECKER | ||
======================= | ||
|
||
Message: Security update available for the module spryker/price-product-merchant-relationship-storage, actual version 1.14.0 | ||
Target: spryker/price-product-merchant-relationship-storage:1.15.0 | ||
``` | ||
|
||
## Example of code that causes an evaluator error | ||
|
||
Your `composer.lock` file contains package versions that have security issues: | ||
|
||
```bash | ||
... | ||
{ | ||
"name": "spryker/price-product-merchant-relationship-storage", | ||
"version": "1.14.0", | ||
"source": { | ||
"type": "git", | ||
"url": "https://github.com/spryker/price-product-merchant-relationship-storage.git", | ||
... | ||
}, | ||
... | ||
```` | ||
|
||
### Resolving the error | ||
|
||
To resolve the error: | ||
1. Upgrade the package to a version where the vulnerability issue is fixed. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to describe that the dependencies are Spryker packages/modules and Spryker Security checker informs about such vulnerabilities very fast.