pnpm audit

Перевіряє наявність відомих проблем безпеки у встановлених пакунках.

Якщо виявлено проблеми з безпекою, спробуйте оновити залежності за допомогою pnpm update. Якщо звичайне оновлення не може виправити всі проблеми, використайте перевизначення overrides, для примусового встановлення версій, які не є вразливими. Наприклад, якщо бібліотека lodash@<2.1.0 є вразливою, скористайтеся цим перевизначенням для встановлення lodash@^2.1.0:

pnpm-workspace.yaml

overrides:
  "lodash@<2.1.0": "^2.1.0"

Або, запустіть pnpm audit --fix.

If you want to tolerate some vulnerabilities as they don't affect your project, you may use the audit.ignore setting.

Починаючи з версії v11, pnpm audit запитує точку доступу реєстру /-/npm/v1/security/advisories/bulk. Відповідь не містить ідентифікаторів CVE, тому повідомлення фільтруються за ідентифікатором повідомлення GitHub (GHSA). If you previously listed CVEs under auditConfig.ignoreCves, replace each entry with the corresponding GHSA-xxxx-xxxx-xxxx value (shown in the More info column of pnpm audit output) under audit.ignore.

Команди

signatures

Додано у: v11.1.0

pnpm audit signatures

Перевіряє підписи реєстру ECDSA для встановлених пакунків відповідно до публічних ключів, опублікованих кожним реєстром за адресою /-/npm/v1/keys. Реєстри з обмеженою видимістю, налаштовані через registries, враховуються; реєстри, які не публікують ключі підпису, пропускаються.

Команда завершує роботу з кодом помилки 1, якщо будь-який пакунок має недійсний підпис, або якщо реєстр оголошує наявність ключів підпису, але пакунок був опублікований без підпису. Використовуйте разом з опцією --json, щоб отримати вихідні дані у форматі, придатному для машинного зчитування.

Параметри

--audit-level <severity>

• Тип: low, moderate, high, critical
• Стандартно: low

Виводить лише ті попередження, серйозність яких більша або дорівнює <severity>.

This can also be set via audit.level in pnpm-workspace.yaml.

--fix

Додає перевизначення до файлу pnpm-workspace.yaml для примусової заміни версій залежностей на безпечні.

Використовуйте --fix=update (додано у v11.0.0) для виправлення вразливостей шляхом оновлення пакунків у файлі блокування замість додавання перевизначень.

Якщо встановлено значення minimumReleaseAge, опція --fix також додає мінімальну виправлену версію кожного повідомлення про вразливість до minimumReleaseAgeExclude у файлі pnpm-workspace.yaml, завдяки чому виправлення безпеки можна встановити, не чекаючи закінчення вікна випуску.

--interactive, -i

Додано у: v11.0.0

Перегляньте повідомлення, відібрані з --fix, і виберіть ті, які потрібно застосувати. Використовується тільки разом з --fix.

--json

Виводить на екран результат перевірки у форматі JSON.

--dev, -D

Перевіряє лише dev залежності.

--prod, -P

Перевіряє лише production залежності.

--no-optional

Не перевіряти optional Dependencies.

--ignore-registry-errors

Якщо реєстр повертає код статусу, відмінний від 200, процес повинен завершитися з 0. Таким чином, процес завершиться невдачею лише у випадку, якщо реєстр успішно відповість і знайде вразливості.

--ignore-unfixable

Додано у: v10.11.0

Ігноруйте всі повідомлення, для яких не знайдено вирішення.

Починаючи з версії v11, повідомлення про невиправні помилки відстежуються GHSA, а не CVE.

--ignore <vulnerability>

Додано у: v10.11.0

Ігнорувати вразливість за її ідентифікатором повідомлення на GitHub (GHSA). До версії v11 цей прапорець приймав ідентифікатори CVE.

Налаштування

pnpm audit is configured in the audit section of pnpm-workspace.yaml (added in v11.16.0):

audit:
  level: high
  ignore:
    - GHSA-42xw-2xvc-qx8m

audit.level

• Стандартно: low
• Тип: low, moderate, high, critical

Only print advisories with severity greater than or equal to this level. Same as the --audit-level flag.

audit.ignore

A list of GHSA codes that will be ignored by the pnpm audit command.

audit:
  ignore:
    - GHSA-42xw-2xvc-qx8m
    - GHSA-4w2v-q235-vp99
    - GHSA-cph5-m8f7-6c5x
    - GHSA-vh95-rmgr-6w4m

інформація

Before v11.16.0, these settings were named auditLevel and auditConfig.ignoreGhsas. The deprecated names keep working until the next major version; when both are set, the audit section takes precedence and a warning is printed.

До версії v11 параметр auditConfig.ignoreCves використовувався для фільтрації повідомлень за ідентифікатором CVE. Цей параметр більше не використовується.