fedcode-next: Support UI and API for patches and diffs

[TG1999]

We need to present patches and diffs in our UI and API. We need to have a design for both before we start working on it.

Reference:

• https://github.com/aboutcode-org/vulnerablecode/commit/93888f14708ebab57faff2bda0d0b9ad9c16b210.patch

[ziadhany]

API design:

• POST /api/v3/packages

{
    "purls": ["pkg:pypi/flask@1.1.0"],
    "details": true,
    "reachability": true
}

Example response:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "purl": "pkg:pypi/flask@1.1.0",
            "affected_by_vulnerabilities": [
                {
                    "advisory_id": "PYSEC-2023-62",
                    "advisory_uid": "pypa/flask/PYSEC-2023-62",
                    "aliases": [
                        "CVE-2023-30861",
                        "GHSA-m2qf-hxjv-5gpq"
                    ],
                    "summary": "Flask is a lightweight WSGI web application framework. When all of the following conditions are met, a response containing data intended for one client may be cached and subsequently sent by the proxy to other clients. If the proxy also caches `Set-Cookie` headers, it may send one client's `session` cookie to other clients. The severity depends on the application's use of the session and the proxy's behavior regarding cookies. The risk depends on all these conditions being met.\n\n1. The application must be hosted behind a caching proxy that does not strip cookies or ignore responses with cookies.\n2. The application sets `session.permanent = True`\n3. The application does not access or modify the session at any point during a request.\n4. `SESSION_REFRESH_EACH_REQUEST` enabled (the default).\n5. The application does not set a `Cache-Control` header to indicate that a page is private or should not be cached.\n\nThis happens because vulnerable versions of Flask only set the `Vary: Cookie` header when the session is accessed or modified, not when it is refreshed (re-sent to update the expiration) without being accessed or modified. This issue has been fixed in versions 2.3.2 and 2.2.5.",
                    "weighted_severity": null,
                    "exploitability": 0.5,
                    "risk_score": null,
                    "fixed_by_packages": [
                        "pkg:pypi/flask@2.2.5",
                        "pkg:pypi/flask@2.3.2"
                    ],
                    "introduced_in_patches": [],
                    "fixed_in_patches": [
                        {
                            "vcs_url": "https://github.com/pallets/flask",
                            "commit_hash": "70f906c51ce49c485f1d355703e9cc3386b1cc2b"
                        },
                        {
                            "vcs_url": "https://github.com/pallets/flask",
                            "commit_hash": "afd63b16170b7c047f5758eb910c416511e9c965"
                        }
                    ],
                    "ssvc_trees": [],
                    "resource_url": "http://localhost:8000/advisories/pypa/flask/PYSEC-2023-62"
                }
            ],
            "fixing_vulnerabilities": [],
            "next_non_vulnerable_version": "2.2.5",
            "latest_non_vulnerable_version": "2.3.2",
            "risk_score": null
        }
    ]
}

[ziadhany]

this is done now, see:

• Add API/ UI support for Patch/PackageCommitPatch #2179
• Rename introduced_in_patch/fixed_in_patch to introduced_in_patches/fixed_in_patches #2343

You can now use the endpoint with the reachability flag set to true:

• POST /api/v3/packages

{
    "purls": ["pkg:pypi/flask@1.1.0"],
    "details": true,
    "reachability": true
}

HTTP 200 OK
Allow: POST, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "purl": "pkg:pypi/flask@1.1.0",
            "affected_by_vulnerabilities": [
                {
                    "advisory_id": "PYSEC-2023-62",
                    "advisory_uid": "pypa/flask/PYSEC-2023-62",
                    "aliases": [
                        "CVE-2023-30861",
                        "GHSA-m2qf-hxjv-5gpq"
                    ],
                    "summary": "Flask is a lightweight WSGI web application framework. When all of the following conditions are met, a response containing data intended for one client may be cached and subsequently sent by the proxy to other clients. If the proxy also caches `Set-Cookie` headers, it may send one client's `session` cookie to other clients. The severity depends on the application's use of the session and the proxy's behavior regarding cookies. The risk depends on all these conditions being met.\n\n1. The application must be hosted behind a caching proxy that does not strip cookies or ignore responses with cookies.\n2. The application sets `session.permanent = True`\n3. The application does not access or modify the session at any point during a request.\n4. `SESSION_REFRESH_EACH_REQUEST` enabled (the default).\n5. The application does not set a `Cache-Control` header to indicate that a page is private or should not be cached.\n\nThis happens because vulnerable versions of Flask only set the `Vary: Cookie` header when the session is accessed or modified, not when it is refreshed (re-sent to update the expiration) without being accessed or modified. This issue has been fixed in versions 2.3.2 and 2.2.5.",
                    "weighted_severity": null,
                    "exploitability": 0.5,
                    "risk_score": null,
                    "fixed_by_packages": [
                        "pkg:pypi/flask@2.2.5",
                        "pkg:pypi/flask@2.3.2"
                    ],
                    "introduced_in_patches": [],
                    "fixed_in_patches": [
                        {
                            "commit_hash": "70f906c51ce49c485f1d355703e9cc3386b1cc2b",
                            "vcs_url": "https://github.com/pallets/flask"
                        },
                        {
                            "commit_hash": "afd63b16170b7c047f5758eb910c416511e9c965",
                            "vcs_url": "https://github.com/pallets/flask"
                        }
                    ],
                    "ssvc_trees": [],
                    "resource_url": "http://localhost:8000/advisories/pypa/flask/PYSEC-2023-62"
                }
            ],
            "fixing_vulnerabilities": [],
            "next_non_vulnerable_version": "2.2.5",
            "latest_non_vulnerable_version": "2.3.2",
            "risk_score": null
        }
    ]
}

The query performance is around

without reachability:
CPU: 51.03ms (70.96 ms)
SQL: 12 queries 15.81ms

with reachability:
CPU 53.77ms (75.59ms)
SQL 14 queries 17.96ms

[TG1999]

@ziadhany please also add "intrdocued_in_patches" data for reference

[ziadhany]

This is an example of the introduced_in_patches data we have.

Request:

resp = requests.post(
    "https://public.vulnerablecode.io/api/v3/packages/",
    headers={"Authorization": "Token <VUL_TOKEN>", "User-Agent": "VCIO_API_AGENT"},
    json={
        "purls": ["pkg:pypi/python-jwt@3.0.0"],
        "details": True,
        "reachability": True
}).json()

Response:

[
  {
    "affected_by_vulnerabilities": [
      {
        "advisory_id": "PYSEC-2022-259",
        "advisory_uid": "pypa/python-jwt/PYSEC-2022-259",
        "aliases": [
          "CVE-2022-39227",
          "GHSA-5p8v-58qm-c7fp",
          "GMS-2022-4408"
        ],
        "exploitability": 0.5,
        "fixed_by_packages": [
          "pkg:pypi/python-jwt@3.3.4"
        ],
        "fixed_in_patches": [
          {
            "commit_hash": "88ad9e67c53aa5f7c43ec4aa52ed34b7930068c9",
            "vcs_url": "https://github.com/davedoesdev/python-jwt"
          }
        ],
        "introduced_in_patches": [
          {
            "commit_hash": "f6d1451012c6a04c2fb1940f0bbd93bb6cf2b025",
            "vcs_url": "https://github.com/davedoesdev/python-jwt"
          }
        ],
        "resource_url": "http://public.vulnerablecode.io/advisories/pypa/python-jwt/PYSEC-2022-259",
        "risk_score": null,
        "ssvc_trees": [
          {
            "decision": "Track",
            "options": [],
            "source_url": "https://github.com/cisagov/vulnrichment/blob/develop/2022/39xxx/CVE-2022-39227.json",
            "vector": "SSVCv2/E:N/A:N/T:P/P:M/B:A/M:M/D:T/2024-07-10T20:53:18Z/"
          }
        ],
        "summary": "An attacker who obtains a JWT can arbitrarily forge its contents without knowing the secret key. Depending on the application, this may for example enable the attacker to spoof other user's identities, hijack their sessions, or bypass authentication.",
        "weighted_severity": null
      },
      {
        "advisory_id": "GHSA-5p8v-58qm-c7fp",
        "advisory_uid": "github_osv/GHSA-5p8v-58qm-c7fp",
        "aliases": [
          "CVE-2022-39227"
        ],
        "exploitability": 0.5,
        "fixed_by_packages": [
          "pkg:pypi/python-jwt@3.3.4"
        ],
        "fixed_in_patches": [],
        "introduced_in_patches": [],
        "resource_url": "http://public.vulnerablecode.io/advisories/github_osv/GHSA-5p8v-58qm-c7fp",
        "risk_score": 4.2,
        "ssvc_trees": [
          {
            "decision": "Track",
            "options": [],
            "source_url": "https://github.com/cisagov/vulnrichment/blob/develop/2022/39xxx/CVE-2022-39227.json",
            "vector": "SSVCv2/E:N/A:N/T:P/P:M/B:A/M:M/D:T/2024-07-10T20:53:18Z/"
          }
        ],
        "summary": "python-jwt vulnerable to token forgery with new claims\n### Impact\nAn attacker who obtains a JWT can arbitrarily forge its c...any questions or comments about this advisory, please open an issue in [python-jwt](https://github.com/davedoesdev/python-jwt)",
        "weighted_severity": 8.4
      }
    ],
    "fixing_vulnerabilities": [],
    "latest_non_vulnerable_version": "3.3.4",
    "next_non_vulnerable_version": "3.3.4",
    "purl": "pkg:pypi/python-jwt@3.0.0",
    "risk_score": 4.2
  }
]