Skip to content

Commit

Permalink
Merge branch 'revert-9e29a344' into 'main'
Browse files Browse the repository at this point in the history
Revert "Merge branch 'CS-41788256-edit-license-in-bom-version' into 'main'"

See merge request CodeScoring/docs!312
  • Loading branch information
amaksimovv committed Feb 7, 2025
2 parents fbfdcb1 + a0fc37d commit 006fd43
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 27 deletions.
Binary file modified docs/assets/img/dependencies_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/img/dependencies_settings_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 4 additions & 14 deletions docs/on-premise/how-to/export-results.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ For CLI projects, SBoM can also be loaded via the interface using the **Import S

## Configuring dependency properties for SBoM export {#bom-settings}

To configure dependency properties, go to the page by clicking the `Configure dependencies` button in the **Dependencies** table of the project.
To configure dependency properties, go to the page by clicking the `Configure BOM` button in the **Dependencies** table of the project.

![Dependencies settings button](/assets/img/dependencies_settings_button.png)

The page allows you to specify the attack surface (**Attack surface**), security function (**Security function**), version control system (**VCS**) and licenses for each project component.
The page allows you to specify the attack surface (**Attack surface**), security function (**Security function**) and code storage system (**VCS**) for each project component.

![Dependencies settings](/assets/img/dependencies_settings.png)

Expand All @@ -55,9 +55,7 @@ The values entered are taken into account:
- when exporting SBoM from the project page;
- when exporting SBoM from the scan results history page (for the most recent successful SCA scan);
- during subsequent scans of the project;
- when scanning the project via the Johnny console agent;
- in the project dashboard;
- on the license page.
- when scanning the project via the Johnny console agent.

**Important**: Changes to values do not apply to previous scans of the project and only relate to the SBoM of the current project, even if a dependency is used in multiple projects.

Expand All @@ -83,12 +81,4 @@ The **Security function** field allows you to specify whether the component belo
- `indirect` — if the component functions participate in the implementation of security functions, interacting with components implementing security functions;
- `no` — if the component functions do not participate in the implementation of security functions (default value).

When exporting SBoM in the `CycloneDX v1.6 Ext JSON` format, the selected value is taken into account in the `"GOST:security_function"` property of the component.

### Licenses

The **Licenses** field allows you to specify the licenses of the component.

If an empty list is specified, the values found during the last SCA analysis are selected.

When exporting SBoM, the selected values are taken into account in the `licenses` field of the component.
When exporting SBoM in the `CycloneDX v1.6 Ext JSON` format, the selected value is taken into account in the `"GOST:security_function"` property of the component.
16 changes: 3 additions & 13 deletions docs/on-premise/how-to/export-results.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ CSV-таблица будет учитывать использованные н

## Настройка свойств зависимостей для выгрузки в SBoM {#bom-settings}

Для настройки свойств зависимостей необходимо перейти на страницу по кнопке `Configure dependencies` в таблице **Dependencies** проекта.
Для настройки свойств зависимостей необходимо перейти на страницу по кнопке `Configure BOM` в таблице **Dependencies** проекта.

![Dependencies settings button](/assets/img/dependencies_settings_button.png)

Страница позволяет указать поверхность атаки (**Attack surface**), функцию безопасности (**Security function**), систему хранения кода (**VCS**) и лицензии (**Licenses**) для каждого компонента проекта.
Страница позволяет указать поверхность атаки (**Attack surface**), функцию безопасности (**Security function**) и систему хранения кода (**VCS**) для каждого компонента проекта.

![Dependencies settings](/assets/img/dependencies_settings.png)

Expand All @@ -55,9 +55,7 @@ CSV-таблица будет учитывать использованные н
- при экспорте SBoM со страницы проекта;
- при экспорте SBoM со страницы истории результатов сканирования (для самого последнего успешного SCA-сканирования);
- при последующих сканированиях проекта;
- при сканировании проекта через консольный агент Johnny;
- в дашборде проекта;
- на странице лицензии.
- при сканировании проекта через консольный агент Johnny.

**Важно**: изменения значений не применяются к предыдущим сканированиям проекта и относятся только к SBoM текущего проекта, даже если зависимость используется в нескольких проектах.

Expand All @@ -84,11 +82,3 @@ CSV-таблица будет учитывать использованные н
- `no` — если функции компонента не участвуют в реализации функций безопасности (значение по умолчанию).

При экспорте SBoM в формате `CycloneDX v1.6 Ext JSON` выбранное значение учитывается в свойстве `"GOST:security_function"` компонента.

### Licenses

Поле **Licenses** позволяет указать лицензии компонента.

При указании пустого списка выбираются значения, найденные при последнем SCA-анализе.

При экспорте SBoM выбранные значения учитываются в поле `licenses` компонента.

0 comments on commit 006fd43

Please sign in to comment.