CVE-2022-31170: @openzeppelin/contracts OpenZeppelin Contracts's ERC165Checker May Revert Vulnerability

HIGH
Advisory Identifier: GHSA-qh9x-gcfh-pcrw
CVSS 7.5
CWE-252 CWE-20
Published
Advisory Summary

CVE-2022-31170 is a HIGH (CVSS 7.5) openzeppelin contracts's erc165checker may revert vulnerability (CWE-252: Unchecked Return Value) affecting @openzeppelin/contracts libraries in the npm ecosystem. The issue involves openzeppelin contracts's erc165checker may revert instead of returning false. Remediation is available by upgrading affected packages to version 4.7.1.

CVE-2022-31170 at a Glance

CVE Identifier CVE-2022-31170
GHSA Identifier GHSA-qh9x-gcfh-pcrw
Severity HIGH
CVSS v3.1 Base Score 7.5
CWE Classification CWE-252: Unchecked Return Value
Affected Product @openzeppelin/contracts
Package Ecosystem npm
Published Date
Last Updated

Security Impact

CVSS: 7.5

The security impact metrics below are parsed directly from the CVSS v3.1 vector string (CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:H/A:N).

Attack Vector Network (AV:N)
Attack Complexity Low (AC:L)
Privileges Required None (PR:N)
User Interaction None (UI:N)
Scope Unchanged (S:U)
Confidentiality None (C:N)
Integrity High (I:H)
Availability None (A:N)

How to Fix CVE-2022-31170

To remediate this vulnerability, upgrade all affected @openzeppelin/contracts dependencies to a patched release. Both direct and transitive dependencies should be checked, as frameworks or security libraries may pull in vulnerable versions transitively.

@openzeppelin/contracts fixed: 4.7.1
npm install @openzeppelin/contracts@4.7.1
@openzeppelin/contracts-upgradeable fixed: 4.7.1
npm install @openzeppelin/contracts-upgradeable@4.7.1
Verify Direct and Transitive Dependencies

Run the following command in your project directory to verify that all resolved dependencies use the patched release:

npm ls @openzeppelin/contracts

How to Check if You Are Affected

To determine whether your Node.js application is affected by CVE-2022-31170, inspect your project dependencies using npm:

npm ls @openzeppelin/contracts

Analyze the terminal output to locate any version of @openzeppelin/contracts in your dependency tree. If any resolved version matches the vulnerable ranges listed in the table below (for example, versions earlier than 4.7.1), your application is affected.

Note: The npm ls @openzeppelin/contracts command inspects dependencies declared in your package.json and lockfile; it does not perform automated runtime dynamic scanning.

Technical Details

Vulnerability Mechanism & Technical Analysis

This vulnerability is classified under CWE-252: Unchecked Return Value, where the product does not check the return value from a method or function, which can prevent it from detecting unexpected states and conditions. In @openzeppelin/contracts, software state validation or input boundaries are circumvented during processing. Review the official source advisory statement below for specific affected components, classes, and reproduction details.

Source Advisory Statement

### Impact `ERC165Checker.supportsInterface` is designed to always successfully return a boolean, and under no circumstance revert. However, an incorrect assumption about Solidity 0.8's `abi.decode` allows some cases to revert, given a target contract that doesn't implement EIP-165 as expected, specifically if it returns a value other than 0 or 1. The contracts that may be affected are those that use `ERC165Checker` to check for support for an interface and then handle the lack of support in a way other than reverting. ### Patches The issue was patched in 4.7.1. ### References https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3552 ### For more information If you have any questions or comments about this advisory, or need assistance deploying the fix, email us at [security@openzeppelin.com](mailto:security@openzeppelin.com).

CVE-2022-31170 Affected @openzeppelin/contracts Versions

2 component(s)
Fixed Versions:
4.7.1
Product / Package Ecosystem Affected Versions Fixed Version
@openzeppelin/contracts
npm
≥ 4.0.0
< 4.7.1
4.7.1
@openzeppelin/contracts-upgradeable
npm
≥ 4.0.0
< 4.7.1
4.7.1

References

Frequently Asked Questions

What is CVE-2022-31170?
CVE-2022-31170 is a security vulnerability in @openzeppelin/contracts involving OpenZeppelin Contracts's ERC165Checker may revert instead of returning false under CWE-252: Unchecked Return Value.
Which @openzeppelin/contracts versions are affected?
Affected versions include releases prior to 4.7.1 across affected packages: @openzeppelin/contracts, @openzeppelin/contracts-upgradeable.
What version fixes CVE-2022-31170?
Upgrading to 4.7.1 (or the latest patched release for your respective branch) resolves the vulnerability.
Is @openzeppelin/contracts affected?
Yes, @openzeppelin/contracts is affected in releases prior to 4.7.1. Upgrade your dependency to 4.7.1 or later.
Is @openzeppelin/contracts-upgradeable affected?
Yes, @openzeppelin/contracts-upgradeable is affected in releases prior to 4.7.1. Upgrade your dependency to 4.7.1 or later.
What is the CVSS score of CVE-2022-31170?
CVE-2022-31170 has a CVSS v3.1 base score of 7.5 (HIGH) with vector string CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:H/A:N.
What CWE is associated with CVE-2022-31170?
CVE-2022-31170 is classified under CWE-252: Unchecked Return Value (The product does not check the return value from a method or function, which can prevent it from detecting unexpected states and conditions.).
How can I check npm dependencies for CVE-2022-31170?
Run the dependency tree command: 'npm ls @openzeppelin/contracts'. This command lists direct and transitive dependencies in your build configuration so you can verify if a vulnerable version is resolved.
Machine-readable OSV JSON OSV v1.5 Schema
Normalized schema output
{
  "schema_version" : "1.4.0",
  "id" : "GHSA-qh9x-gcfh-pcrw",
  "modified" : "2022-08-10T23:52:57Z",
  "published" : "2022-07-21T22:33:01Z",
  "aliases" : [ "CVE-2022-31170" ],
  "summary" : "OpenZeppelin Contracts's ERC165Checker may revert instead of returning false",
  "details" : "### Impact\n\n`ERC165Checker.supportsInterface` is designed to always successfully return a boolean, and under no circumstance revert. However, an incorrect assumption about Solidity 0.8's `abi.decode` allows some cases to revert, given a target contract that doesn't implement EIP-165 as expected, specifically if it returns a value other than 0 or 1.\n\nThe contracts that may be affected are those that use `ERC165Checker` to check for support for an interface and then handle the lack of support in a way other than reverting.\n\n### Patches\n\nThe issue was patched in 4.7.1.\n\n### References\n\nhttps://github.com/OpenZeppelin/openzeppelin-contracts/pull/3552\n\n### For more information\n\nIf you have any questions or comments about this advisory, or need assistance deploying the fix, email us at [security@openzeppelin.com](mailto:security@openzeppelin.com).\n",
  "severity" : [ {
    "type" : "CVSS_V3",
    "score" : "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:H/A:N"
  } ],
  "affected" : [ {
    "package" : {
      "ecosystem" : "npm",
      "name" : "@openzeppelin/contracts"
    },
    "ranges" : [ {
      "type" : "ECOSYSTEM",
      "events" : [ {
        "introduced" : "4.0.0"
      }, {
        "fixed" : "4.7.1"
      } ]
    } ]
  }, {
    "package" : {
      "ecosystem" : "npm",
      "name" : "@openzeppelin/contracts-upgradeable"
    },
    "ranges" : [ {
      "type" : "ECOSYSTEM",
      "events" : [ {
        "introduced" : "4.0.0"
      }, {
        "fixed" : "4.7.1"
      } ]
    } ]
  } ],
  "references" : [ {
    "type" : "WEB",
    "url" : "https://github.com/OpenZeppelin/openzeppelin-contracts/security/advisories/GHSA-qh9x-gcfh-pcrw"
  }, {
    "type" : "ADVISORY",
    "url" : "https://nvd.nist.gov/vuln/detail/CVE-2022-31170"
  }, {
    "type" : "WEB",
    "url" : "https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3552"
  }, {
    "type" : "PACKAGE",
    "url" : "https://github.com/OpenZeppelin/openzeppelin-contracts"
  } ],
  "database_specific" : {
    "cwe_ids" : [ "CWE-20", "CWE-252" ],
    "severity" : "HIGH",
    "github_reviewed" : true,
    "github_reviewed_at" : "2022-07-21T22:33:01Z",
    "nvd_published_at" : "2022-07-22T04:15:00Z"
  }
}