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

SDK-4093. Added Security update checker doc #2066

Merged
merged 3 commits into from
Aug 3, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Copy link
Contributor

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.


## 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.
Loading