Skip to content

Commit 7b20a23

Browse files
committed
Merge branch 'master' into 'feedback'
# Conflicts: # mkdocs.yml
2 parents 8f717ac + 936d9e0 commit 7b20a23

89 files changed

Lines changed: 4234 additions & 664 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitlab-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ lint_markdown:
113113
done
114114
115115
# URLs
116-
IGNORED_DOMAINS='https://download.pytorch.org`|bdu.fstec.ru|{osa-proxy-url}|artifactory.domain.ru|{REGISTRY_URL}/repository/helm|index.codescoring.ru|index-proxy:8000|webhook|atlassian|nuget|pypi|npmjs|maven|registry|mycompany|k8s|example|gitflic\.ru|localhost|127\.0\.0\.1|tip\.kaspersky\.com|JFROG_URL|host|jfrog\.my\.domain|docs\.alpinelinux\.org|github\.com|spdx\.github\.io'
116+
IGNORED_DOMAINS='https://download.pytorch.org`|bdu.fstec.ru|{osa-proxy-url}|artifactory.domain.ru|{REGISTRY_URL}/repository/helm|index.codescoring.ru|index-proxy:8000|webhook|atlassian|nuget|pypi|npmjs|maven|registry|mycompany|k8s|example|gitflic\.ru|localhost|127\.0\.0\.1|tip\.kaspersky\.com|JFROG_URL|host|jfrog\.my\.domain|docs\.alpinelinux\.org|github\.com|spdx\.github\.io|docs\.python\.org|dev\.azure\.com/<organisation|https://<organisation|REGISTRY_USERNAME|REGISTRY_PASSWORD|REGISTRY_URL|drive\.google\.com|gitlab\.com|gitlab\.community\.ispras\.ru'
117117
if command -v wget >/dev/null; then
118118
for file in $FILES; do
119119
URLS=$(grep -oP '(?:\[.*?\]\(\Khttp[s]?://[^\s)]+|(?<!\]\()http[s]?://[^\s>]+)' "$file" | sed 's/]\+$//' | grep -Ev "$IGNORED_DOMAINS" || true)

docs/agent/config.en.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,16 @@ You can manage the parameters of the CLI agent by adding the configuration file
6363
- **match** – condition for matching suitable manifests, can be by name (`equal`) or extension (`extension`);
6464
- **properties** – additional properties for environment parsers, such as the path to executables;
6565
- **dotnet-path**, **maven-path**, **gradle-path**, **yarn-path**, **go-path**, **sbt-path**, **npm-path**, **pnpm-path**, **composer-path**, **pip-path**, **poetry-path**, **conda-lock-path** – paths to package managers for dependency resolution in the environment;
66+
- <a href="/changelog/on-premise-changelog.en/#2025450-2025-11-07" class="version-tag">2025.45.0</a> **pipdeptree-path** – path to `pipdeptree` for dependency resolution in the environment;
67+
- <a href="/changelog/on-premise-changelog.en/#202630-2026-01-16" class="version-tag">2026.3.0</a> **bun-path** – path to `bun` for dependency resolution in the environment;
68+
- <a href="/changelog/on-premise-changelog.en/#2025450-2025-11-07" class="version-tag">2025.45.0</a> **uv-path** – path to `uv` for dependency resolution in the environment;
69+
- <a href="/changelog/on-premise-changelog.en/#2025130-2025-03-28" class="version-tag">2025.13.0</a> **swift-path** – path to `swift` for dependency resolution in the environment;
6670
- **resolve-enabled** – enables dependency resolution in the environment. Default value is `false`;
67-
- **dotnet-args**, **gradle-args**, **maven-args**, **sbt-args**, **npm-args**, **yarn-args**, **pnpm-args**, **composer-args**, **poetry-args**, **conda-args**, **swift-args** – arguments to pass to the corresponding package managers when resolving dependencies in the environment;
71+
- **dotnet-args**, **gradle-args**, **maven-args**, **sbt-args**, **npm-args**, **yarn-args**, **pnpm-args**, **composer-args**, **poetry-args**, **conda-args** – arguments to pass to the corresponding package managers when resolving dependencies in the environment;
72+
- <a href="/changelog/on-premise-changelog.en/#2025450-2025-11-07" class="version-tag">2025.45.0</a> **pipdeptree-args** – arguments to pass to `pipdeptree` during dependency resolution in the environment;
73+
- <a href="/changelog/on-premise-changelog.en/#202630-2026-01-16" class="version-tag">2026.3.0</a> **bun-args** – arguments to pass to `bun` during dependency resolution in the environment;
74+
- <a href="/changelog/on-premise-changelog.en/#2025450-2025-11-07" class="version-tag">2025.45.0</a> **uv-args** – arguments to pass to `uv` during dependency resolution in the environment;
75+
- <a href="/changelog/on-premise-changelog.en/#2025130-2025-03-28" class="version-tag">2025.13.0</a> **swift-args** – arguments to pass to `swift` during dependency resolution in the environment;
6876
- **configuration** – configuration for the `gradle-dependency-tree_txt` parser;
6977
- **depth** – parsing depth for the `jar` parser. Default value is `1`;
7078
- **python-version** – Python version used for dependency resolution in the environment.
@@ -76,16 +84,16 @@ You can manage the parameters of the CLI agent by adding the configuration file
7684

7785
### Output parameters
7886

79-
- **format** – output format for found vulnerabilities. Default value is `coloredtable`. Export to formats `table`, `text`, `junit`, `sarif`, `csv`, `gl-dependency-scanning-report`, `gl-code-quality-report` is available;
80-
- **group-vulnerabilities-by** – field used to group vulnerabilities in the table;
81-
- **sort-vulnerabilities-by** – order of fields for sorting vulnerabilities in the table;
82-
- **alerts-format** – output format for the policy alerts report. Supported formats: `coloredtable`, `table`, `text`, `json`, `csv`. Default value is `coloredtable`.
87+
- <a href="/changelog/on-premise-changelog.en/#2023480-2023-11-22" class="version-tag">2023.48.0</a> **format** – output format for found vulnerabilities. Default value is `coloredtable`. Export to formats `table`, `text`, `junit`, `sarif`, `csv`, `gl-dependency-scanning-report`, `gl-code-quality-report` is available;
88+
- <a href="/changelog/on-premise-changelog.en/#2023480-2023-11-22" class="version-tag">2023.48.0</a> **group-vulnerabilities-by** – field used to group vulnerabilities in the table;
89+
- <a href="/changelog/on-premise-changelog.en/#2023480-2023-11-22" class="version-tag">2023.48.0</a> **sort-vulnerabilities-by** – order of fields for sorting vulnerabilities in the table;
90+
- <a href="/changelog/on-premise-changelog.en/#2025290-2025-07-18" class="version-tag">2025.29.0</a> **alerts-format** – output format for the policy alerts report. Supported formats: `coloredtable`, `table`, `text`, `json`, `csv`. Default value is `coloredtable`.
8391

8492
### Platform parameters
8593

8694
- **api_url** – platform address;
8795
- **api_token** – token for access to the platform;
88-
- **localization** — CLI output localization language. Possible values: `en`, `ru`. The default value is `en`.
96+
- <a href="/changelog/on-premise-changelog.en/#202630-2026-01-16" class="version-tag">2026.3.0</a> **localization** — CLI output localization language. Possible values: `en`, `ru`. The default value is `en`.
8997

9098
### Secret scanning launch parameters
9199

@@ -103,13 +111,12 @@ You can manage the parameters of the CLI agent by adding the configuration file
103111
- <a href="/changelog/on-premise-changelog.en/#2025130-2025-03-28" class="version-tag">2025.13.0</a> **max-decode-depth** – maximum depth for recursive decoding. A value of `0` disables decoding;
104112
- <a href="/changelog/on-premise-changelog.en/#2025130-2025-03-28" class="version-tag">2025.13.0</a> **max-target-megabytes** – maximum file size (in megabytes) to be processed. Files exceeding this size will be skipped. Default: `0` (no limit);
105113
- <a href="/changelog/on-premise-changelog.en/#2025130-2025-03-28" class="version-tag">2025.13.0</a> **no-banner** – disables the Gitleaks startup banner. Default: `false`;
106-
- <a href="/changelog/on-premise-changelog,en/#2025130-2025-03-28" class="version-tag">2025.13.0</a> **no-color** – disables colored output in verbose mode. Default: `false`;
114+
- <a href="/changelog/on-premise-changelog.en/#2025130-2025-03-28" class="version-tag">2025.13.0</a> **no-color** – disables colored output in verbose mode. Default: `false`;
107115
- <a href="/changelog/on-premise-changelog.en/#2025130-2025-03-28" class="version-tag">2025.13.0</a> **redact** – masks detected secrets in logs and console output. A value of 0 fully reveals secrets, while 100 completely hides them. Intermediate values, such as 20, mask 20% of the secret. Default: `0`;
108116
- <a href="/changelog/on-premise-changelog.en/#2025130-2025-03-28" class="version-tag">2025.13.0</a> **verbose** – enables verbose output during scanning. Default: `false`.
109117

110118
## Example file
111119

112-
```yaml
113120
```yaml
114121
# analysis options
115122
analysis:

docs/agent/config.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,16 @@ hide:
6363
- **match** – условие для определения подходящих манифестов, может быть по названию (`equal`) или расширению (`extension`);
6464
- **properties** – дополнительные свойства для парсеров окружения, такие как путь к исполняемым файлам;
6565
- **dotnet-path**, **maven-path**, **gradle-path**, **yarn-path**, **go-path**, **sbt-path**,**npm-path**, **pnpm-path**, **composer-path**, **pip-path**, **poetry-path**, **conda-lock-path** – пути к пакетным менеджерам для разрешения зависимостей в окружении;
66+
- <a href="/changelog/on-premise-changelog/#2025450-2025-11-07" class="version-tag">2025.45.0</a> **pipdeptree-path** – путь к `pipdeptree` для разрешения зависимостей в окружении;
67+
- <a href="/changelog/on-premise-changelog/#202630-2026-01-16" class="version-tag">2026.3.0</a> **bun-path** – путь к `bun` для разрешения зависимостей в окружении;
68+
- <a href="/changelog/on-premise-changelog/#2025450-2025-11-07" class="version-tag">2025.45.0</a> **uv-path** – путь к `uv` для разрешения зависимостей в окружении;
69+
- <a href="/changelog/on-premise-changelog/#2025130-2025-03-28" class="version-tag">2025.13.0</a> **swift-path** – путь к `swift` для разрешения зависимостей в окружении;
6670
- **resolve-enabled** – разрешение зависимостей в окружении. По умолчанию значение `false`;
67-
- **dotnet-args**, **gradle-args**, **maven-args**, **sbt-args**, **npm-args**, **yarn-args**, **pnpm-args**, **composer-args**, **poetry-args**, **conda-args**, **swift-args** – аргументы для передачи соответствующим пакетным менеджерам при разрешении зависимостей в окружении;
71+
- **dotnet-args**, **gradle-args**, **maven-args**, **sbt-args**, **npm-args**, **yarn-args**, **pnpm-args**, **composer-args**, **poetry-args**, **conda-args** – аргументы для передачи соответствующим пакетным менеджерам при разрешении зависимостей в окружении;
72+
- <a href="/changelog/on-premise-changelog/#2025450-2025-11-07" class="version-tag">2025.45.0</a> **pipdeptree-args** – аргументы для передачи `pipdeptree` при разрешении зависимостей в окружении;
73+
- <a href="/changelog/on-premise-changelog/#202630-2026-01-16" class="version-tag">2026.3.0</a> **bun-args** – аргументы для передачи `bun` при разрешении зависимостей в окружении;
74+
- <a href="/changelog/on-premise-changelog/#2025450-2025-11-07" class="version-tag">2025.45.0</a> **uv-args** – аргументы для передачи `uv` при разрешении зависимостей в окружении;
75+
- <a href="/changelog/on-premise-changelog/#2025130-2025-03-28" class="version-tag">2025.13.0</a> **swift-args** – аргументы для передачи `swift` при разрешении зависимостей в окружении;
6876
- **configuration** – конфигурация для парсера `gradle-dependency-tree_txt`;
6977
- **depth** – глубина парсинга для парсера `jar`. По умолчанию значение `1`;
7078
- **python-version** – версия Python, используемая для разрешения зависимостей в окружении.
@@ -76,16 +84,16 @@ hide:
7684

7785
### Параметры вывода результатов
7886

79-
- **format** – формат вывода найденных уязвимостей. По умолчанию `coloredtable`. Возможна выгрузка в форматы `table`, `text`, `junit`, `sarif`, `csv`, `gl-dependency-scanning-report`, `gl-code-quality-report`;
80-
- **group-vulnerabilities-by** – переменная для группировки уязвимостей в таблице;
81-
- **sort-vulnerabilities-by** – порядок переменных для сортировки уязвимостей в таблице;
82-
- **alerts-format** – формат вывода отчёта по срабатываниям политик. Поддерживаются форматы: `coloredtable`, `table`, `text`, `json`, `csv`. Значение по умолчанию – `coloredtable`.
87+
- <a href="/changelog/on-premise-changelog/#2023480-2023-11-22" class="version-tag">2023.48.0</a> **format** – формат вывода найденных уязвимостей. По умолчанию `coloredtable`. Возможна выгрузка в форматы `table`, `text`, `junit`, `sarif`, `csv`, `gl-dependency-scanning-report`, `gl-code-quality-report`;
88+
- <a href="/changelog/on-premise-changelog/#2023480-2023-11-22" class="version-tag">2023.48.0</a> **group-vulnerabilities-by** – переменная для группировки уязвимостей в таблице;
89+
- <a href="/changelog/on-premise-changelog/#2023480-2023-11-22" class="version-tag">2023.48.0</a> **sort-vulnerabilities-by** – порядок переменных для сортировки уязвимостей в таблице;
90+
- <a href="/changelog/on-premise-changelog/#2025290-2025-07-18" class="version-tag">2025.29.0</a> **alerts-format** – формат вывода отчёта по срабатываниям политик. Поддерживаются форматы: `coloredtable`, `table`, `text`, `json`, `csv`. Значение по умолчанию – `coloredtable`.
8391

8492
### Параметры платформы
8593

8694
- **api_url** – адрес платформе;
8795
- **api_token** – токен для доступа к платформе;
88-
- **localization** — язык локализации вывода CLI. Возможные значения: `en`, `ru`. Значение по умолчанию — `en`.
96+
- <a href="/changelog/on-premise-changelog/#202630-2026-01-16" class="version-tag">2026.3.0</a> **localization** — язык локализации вывода CLI. Возможные значения: `en`, `ru`. Значение по умолчанию — `en`.
8997

9098

9199
### Параметры запуска поиска секретов

docs/agent/gitlab-ci.en.md

Lines changed: 53 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,34 @@ The CLI agent supports integration into Gitlab CI using the `.gitlab-ci.yaml` fi
99

1010
### Johnny Docker image
1111

12-
An example of the contents of the `.gitlab-ci.yaml` file when using a Docker image of the agent:
13-
14-
`<version>` must be replaced with the agent version. A list of current versions with descriptions is available in [Changelog](/changelog/johnny-changelog.en/).
15-
16-
```yaml
17-
stages:
18-
- test
19-
20-
sca:
21-
stage: test
22-
23-
script:
24-
- docker pull REGISTRY_URL/johnny-depp:<version>
25-
->
26-
docker run -v $(pwd):/code
27-
<registry-address>/johnny-depp
28-
--api_token $CODESCORING_API_TOKEN
29-
--api_url $CODESCORING_API_URL
30-
--ignore.git
31-
--ignore fixtures
32-
--ignore parsers
33-
.
34-
35-
artifacts:
36-
paths:
37-
-bom.json
38-
when: always
39-
expire_in: 1 week
40-
```
12+
!!! example "Example .gitlab-ci.yaml file (Docker image)"
13+
`<version>` must be replaced with the agent version. A list of current versions with descriptions is available in [Changelog](/changelog/johnny-changelog.en/).
14+
15+
```yaml
16+
stages:
17+
- test
18+
19+
sca:
20+
stage: test
21+
22+
script:
23+
- docker pull REGISTRY_URL/johnny-depp:<version>
24+
->
25+
docker run -v $(pwd):/code
26+
<registry-address>/johnny-depp
27+
--api_token $CODESCORING_API_TOKEN
28+
--api_url $CODESCORING_API_URL
29+
--ignore.git
30+
--ignore fixtures
31+
--ignore parsers
32+
.
33+
34+
artifacts:
35+
paths:
36+
-bom.json
37+
when: always
38+
expire_in: 1 week
39+
```
4140

4241
### Johnny binary file
4342

@@ -57,29 +56,28 @@ To use the agent binary file, you must first perform the following steps on the
5756
chmod +x /usr/local/bin/johnny
5857
```
5958

60-
An example of executing the binary file in `.gitlab-ci.yaml`:
61-
62-
```yaml
63-
stages:
64-
-test
65-
66-
sca:
67-
stage: test
68-
69-
script:
70-
->
71-
johnny
72-
scan dir
73-
--api_token $JOHNNY_API_TOKEN
74-
--api_url $JOHNNY_API_URL
75-
--ignore.git
76-
--ignore fixtures
77-
--ignore parsers
78-
.
79-
80-
artifacts:
81-
paths:
82-
-bom.json
83-
when: always
84-
expire_in: 1 week
85-
```
59+
!!! example "Example .gitlab-ci.yaml (binary file)"
60+
```yaml
61+
stages:
62+
-test
63+
64+
sca:
65+
stage: test
66+
67+
script:
68+
->
69+
johnny
70+
scan dir
71+
--api_token $JOHNNY_API_TOKEN
72+
--api_url $JOHNNY_API_URL
73+
--ignore.git
74+
--ignore fixtures
75+
--ignore parsers
76+
.
77+
78+
artifacts:
79+
paths:
80+
-bom.json
81+
when: always
82+
expire_in: 1 week
83+
```

docs/agent/gitlab-ci.md

Lines changed: 53 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,34 @@ hide:
99

1010
### Docker-образ Johnny
1111

12-
Пример содержания файла `.gitlab-ci.yaml` при использовании docker-образа консольного агента:
13-
14-
`<version>` необходимо заменить на версию агента. Список актуальных версий с описанием доступен на странице [Changelog](/changelog/johnny-changelog/).
15-
16-
```yaml
17-
stages:
18-
- test
19-
20-
sca:
21-
stage: test
22-
23-
script:
24-
- docker pull REGISTRY_URL/johnny-depp:<version>
25-
- >
26-
docker run -v $(pwd):/code
27-
<registry-address>/johnny-depp
28-
--api_token $CODESCORING_API_TOKEN
29-
--api_url $CODESCORING_API_URL
30-
--ignore .git
31-
--ignore fixtures
32-
--ignore parsers
33-
.
34-
35-
artifacts:
36-
paths:
37-
- bom.json
38-
when: always
39-
expire_in: 1 week
40-
```
12+
!!! example "Пример файла .gitlab-ci.yaml (Docker-образ)"
13+
`<version>` необходимо заменить на версию агента. Список актуальных версий с описанием доступен на странице [Changelog](/changelog/johnny-changelog/).
14+
15+
```yaml
16+
stages:
17+
- test
18+
19+
sca:
20+
stage: test
21+
22+
script:
23+
- docker pull REGISTRY_URL/johnny-depp:<version>
24+
- >
25+
docker run -v $(pwd):/code
26+
<registry-address>/johnny-depp
27+
--api_token $CODESCORING_API_TOKEN
28+
--api_url $CODESCORING_API_URL
29+
--ignore .git
30+
--ignore fixtures
31+
--ignore parsers
32+
.
33+
34+
artifacts:
35+
paths:
36+
- bom.json
37+
when: always
38+
expire_in: 1 week
39+
```
4140

4241
### Бинарный файл Johnny
4342

@@ -57,29 +56,28 @@ sca:
5756
chmod +x /usr/local/bin/johnny
5857
```
5958

60-
Пример вызова бинарного файла агента в `.gitlab-ci.yaml`:
61-
62-
```yaml
63-
stages:
64-
- test
65-
66-
sca:
67-
stage: test
68-
69-
script:
70-
- >
71-
johnny
72-
scan dir
73-
--api_token $JOHNNY_API_TOKEN
74-
--api_url $JOHNNY_API_URL
75-
--ignore .git
76-
--ignore fixtures
77-
--ignore parsers
78-
.
79-
80-
artifacts:
81-
paths:
82-
- bom.json
83-
when: always
84-
expire_in: 1 week
85-
```
59+
!!! example "Пример вызова в .gitlab-ci.yaml (бинарный файл)"
60+
```yaml
61+
stages:
62+
- test
63+
64+
sca:
65+
stage: test
66+
67+
script:
68+
- >
69+
johnny
70+
scan dir
71+
--api_token $JOHNNY_API_TOKEN
72+
--api_url $JOHNNY_API_URL
73+
--ignore .git
74+
--ignore fixtures
75+
--ignore parsers
76+
.
77+
78+
artifacts:
79+
paths:
80+
- bom.json
81+
when: always
82+
expire_in: 1 week
83+
```

0 commit comments

Comments
 (0)