Restructure solution layout by module
This commit is contained in:
@@ -0,0 +1,29 @@
|
||||
# AGENTS
|
||||
## Role
|
||||
Japan JVN/MyJVN connector; national CERT enrichment with strong identifiers (JVNDB) and vendor status; authoritative only where concrete package evidence exists; otherwise enriches text, severity, references, and aliases.
|
||||
## Scope
|
||||
- Fetch JVNRSS (overview) and VULDEF (detail) via MyJVN API; window by dateFirstPublished/dateLastUpdated; paginate; respect rate limits.
|
||||
- Validate XML or JSON payloads; normalize titles, CVEs, JVNDB ids, vendor status, categories; map references and severity text; attach jp_flags.
|
||||
- Persist raw docs with sha256 and headers; manage source_state cursor; idempotent parse/map.
|
||||
## Participants
|
||||
- Source.Common (HTTP, pagination, XML or XSD validators, retries/backoff).
|
||||
- Storage.Mongo (document, dto, advisory, alias, affected (when concrete), reference, jp_flags, source_state).
|
||||
- Models (canonical Advisory/Affected/Provenance).
|
||||
- Core/WebService (jobs: source:jvn:fetch|parse|map).
|
||||
- Merge engine applies enrichment precedence (does not override distro or PSIRT ranges unless JVN gives explicit package truth).
|
||||
## Interfaces & contracts
|
||||
- Aliases include JVNDB-YYYY-NNNNN and CVE ids; scheme "JVNDB".
|
||||
- jp_flags: { jvndb_id, jvn_category, vendor_status }.
|
||||
- References typed: advisory/vendor/bulletin; URLs normalized and deduped.
|
||||
- Affected only when VULDEF gives concrete coordinates; otherwise omit.
|
||||
- Provenance: method=parser; kind=api; value=endpoint plus query window; recordedAt=fetched time.
|
||||
## In/Out of scope
|
||||
In: JVN/MyJVN ingestion, aliases, jp_flags, enrichment mapping, watermarking.
|
||||
Out: overriding distro or PSIRT ranges without concrete evidence; scraping unofficial mirrors.
|
||||
## Observability & security expectations
|
||||
- Metrics: SourceDiagnostics emits `concelier.source.http.*` counters/histograms tagged `concelier.source=jvn`, enabling dashboards to track fetch requests, item counts, parse failures, and enrichment/map activity (including jp_flags) via tag filters.
|
||||
- Logs: window bounds, jvndb ids processed, vendor_status distribution; redact API keys.
|
||||
## Tests
|
||||
- Author and review coverage in `../StellaOps.Concelier.Connector.Jvn.Tests`.
|
||||
- Shared fixtures (e.g., `MongoIntegrationFixture`, `ConnectorTestHarness`) live in `../StellaOps.Concelier.Testing`.
|
||||
- Keep fixtures deterministic; match new cases to real-world advisories or regression scenarios.
|
||||
Reference in New Issue
Block a user