Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Security Policy

Thanks for helping keep **StitchAPI** and its users safe. This document explains
which releases receive security fixes, how to report a vulnerability privately,
and what to expect once you do.

`stitchapi` is a client-side runtime library: it composes and runs API calls,
handles credentials (bearer / apiKey / basic / oauth2 / cookieSession), redacts
secrets from traces, generates code from OpenAPI specs, and runs untrusted
snippets in the docs playground sandbox. Those are the areas where a bug is most
likely to have security impact — see [Scope](#scope) below.

## Supported versions

Security fixes are issued against the **most recent published release** of
`stitchapi` and the `@stitchapi/*` companion packages that ship in lockstep with
it. Older majors and minors are not backported unless explicitly noted in an
advisory.

| Version | Supported |
| ----------------------------------------------------- | ------------------ |
| Latest `1.0.x` (and current `1.0.0-rc.x` prereleases) | :white_check_mark: |
| `0.x` | :x: |

## Reporting a vulnerability

**Please do not open a public GitHub issue, discussion, or pull request for a
security problem** — that discloses it to everyone before a fix exists.

Report it privately through either channel:

1. **GitHub private vulnerability reporting (preferred).** Open the repository's
[**Security** tab](https://github.com/rejifald/StitchAPI/security) and choose
**“Report a vulnerability.”** This opens a private advisory visible only to
you and the maintainers, with a place to attach details and a proof of
concept.
2. **Email.** If you cannot use GitHub advisories, email the maintainer at
**rejifald@gmail.com** with the subject line `StitchAPI security`. Encrypt or
ask for a secure channel if the report is sensitive.

Please include, as far as you can:

- the affected package(s) and version(s), or a commit SHA;
- the impact (what an attacker can do);
- clear reproduction steps or a minimal proof of concept;
- any known mitigations or a suggested fix.

## What to expect

- **Acknowledgement** within **48 hours**.
- An initial assessment — severity and whether we can reproduce it — within a
few business days.
- A fix released as quickly as the severity warrants (critical issues first),
published as a [GitHub Security Advisory][advisories] with a CVE where one
applies. We'll keep you posted on progress and coordinate public disclosure
with you.
- **Credit** in the advisory and release notes unless you'd rather stay
anonymous.

We ask that you give us reasonable time to release a fix before any public
disclosure. Acting in good faith under this policy — investigating and reporting
without destroying data, degrading service, or accessing more data than needed
to demonstrate the issue — is welcome, and we will not pursue or support legal
action against research conducted that way.

## Scope

In scope — vulnerabilities in the published library, for example:

- credential or secret **leakage** (e.g. auth headers surviving a cross-origin
redirect, secrets escaping trace redaction);
- **injection** in code generation (`stitch gen` / `@stitchapi/openapi`) from an
untrusted OpenAPI spec;
- **sandbox escape or egress confinement bypass** in the docs playground
(`docs/sandbox`, `apps/docs`);
- SSRF, prototype pollution, ReDoS, or similar reachable through the library's
public API with realistic inputs.

Out of scope:

- vulnerabilities whose root cause is in an application or service that uses
StitchAPI, rather than in StitchAPI itself;
- issues that require an already-compromised host, a malicious dependency you
chose to install, or physical/privileged local access;
- reports generated solely by an automated scanner with no demonstrated,
practical impact;
- missing hardening headers or best-practice suggestions on `stitchapi.dev`
without a concrete exploit.

If you are unsure whether something is in scope, report it anyway — we would
rather hear about it.

[advisories]: https://github.com/rejifald/StitchAPI/security/advisories
Loading