Skip to content

Commit 43950ed

Browse files
committed
Add security policy, bug reporting guide, and project repository list
- SECURITY.md: private reporting channels, coordinated disclosure timeline, supported versions, and scope notes - README: how to report bugs vs vulnerabilities, and a table of all lm15-dev codebases with status and role (OSPS Baseline OSPS-VM-02, OSPS-DO-02, OSPS-QA-04)
1 parent 8d7a17e commit 43950ed

2 files changed

Lines changed: 77 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -549,3 +549,33 @@ API reference, the specification pages, benchmarks, and the
549549
Fixture and conformance workflows, the doc-drift checker, the provider
550550
adapter development guide, and the useful-commands cheat sheet live in
551551
[CONTRIBUTING.md](CONTRIBUTING.md).
552+
553+
## Reporting bugs and security issues
554+
555+
- **Bugs and unexpected behavior**: open an issue on the
556+
[issue tracker](https://github.com/lm15-dev/lm15-python/issues). Include
557+
the lm15 version, the provider and endpoint involved, and a minimal
558+
reproduction. Wire-level evidence (the exact request/response bytes)
559+
makes triage much faster.
560+
- **Security vulnerabilities**: never open a public issue. Follow
561+
[SECURITY.md](SECURITY.md) to report privately.
562+
563+
## Project repositories
564+
565+
lm15 is a multi-repository project under the
566+
[lm15-dev](https://github.com/lm15-dev) organization:
567+
568+
| Repository | Status | Role |
569+
| --- | --- | --- |
570+
| [lm15-contract](https://github.com/lm15-dev/lm15-contract) | active | The authority: canonical spec, fixture corpus, goldens, and the language-neutral conformance harness. |
571+
| [lm15-python](https://github.com/lm15-dev/lm15-python) | active | This repository — the Python reference implementation. |
572+
| [lm15-ts](https://github.com/lm15-dev/lm15-ts) | active | TypeScript implementation. |
573+
| [lm15-go](https://github.com/lm15-dev/lm15-go) | active | Go implementation. |
574+
| [lm15-rs](https://github.com/lm15-dev/lm15-rs) | active | Rust implementation. |
575+
| [lm15-jl](https://github.com/lm15-dev/lm15-jl) | archived | Frozen pre-conformance Julia port. |
576+
| [spec](https://github.com/lm15-dev/spec) | archived | Superseded by lm15-contract. |
577+
| [curl-fixtures](https://github.com/lm15-dev/curl-fixtures), [cross-sdk-curl-tests](https://github.com/lm15-dev/cross-sdk-curl-tests) | archived | Moved into the conformance corpus. |
578+
579+
`lm15-contract` is the source of truth for behavior; each implementation
580+
repo must pass its conformance harness at the SHA pinned in its
581+
`CONTRACT_PIN` file.

‎SECURITY.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Security Policy
2+
3+
## Supported versions
4+
5+
Only the latest release published on PyPI receives security fixes.
6+
The legacy `0.2.x` line (branch `legacy-0.2`) is unsupported and will
7+
not receive fixes.
8+
9+
## Reporting a vulnerability
10+
11+
Do not open a public issue for a security problem.
12+
13+
Report privately, either way works:
14+
15+
1. **GitHub private vulnerability reporting** (preferred):
16+
[github.com/lm15-dev/lm15-python/security/advisories/new](https://github.com/lm15-dev/lm15-python/security/advisories/new)
17+
2. **Email** the security contact: Maxime Rivest <mrive052@gmail.com>
18+
with a subject starting with `[lm15 security]`.
19+
20+
Include what you can: affected version, provider/endpoint involved, a
21+
minimal reproduction, and the impact you believe it has.
22+
23+
## What to expect (coordinated disclosure)
24+
25+
- Acknowledgement of your report within **7 days**.
26+
- An assessment (accepted, declined, or needs more info) within **14 days**.
27+
- A coordinated fix and public disclosure within **90 days** of the
28+
report, sooner when a fix is ready. If more time is genuinely needed,
29+
we will agree on a new date with the reporter.
30+
- Fixed vulnerabilities are published as
31+
[GitHub Security Advisories](https://github.com/lm15-dev/lm15-python/security/advisories)
32+
with affected versions and upgrade instructions.
33+
34+
## Scope notes
35+
36+
lm15 is a low-level client library. Things we consider security bugs
37+
include, but are not limited to:
38+
39+
- API keys or other credentials being logged, serialized, or sent to a
40+
host other than the intended provider endpoint.
41+
- Requests being routed to a different endpoint than the one the code
42+
specifies (for example through URL construction bugs).
43+
- Unsafe handling of untrusted provider responses (streaming/SSE
44+
parsing, JSON deserialization) that leads to more than a clean error.
45+
46+
Bugs without a security impact belong in the
47+
[issue tracker](https://github.com/lm15-dev/lm15-python/issues).

0 commit comments

Comments
 (0)