Skip to content

docs: add camel-karaf security model, SECURITY.md and AGENTS.md#706

Merged
oscerd merged 3 commits into
apache:mainfrom
oscerd:docs/security-model
May 18, 2026
Merged

docs: add camel-karaf security model, SECURITY.md and AGENTS.md#706
oscerd merged 3 commits into
apache:mainfrom
oscerd:docs/security-model

Conversation

@oscerd
Copy link
Copy Markdown
Contributor

@oscerd oscerd commented May 15, 2026

What

Adds a Karaf-specific threat model for camel-karaf, plus the supporting
SECURITY.md reporting pointer and AGENTS.md AI-agent guidelines — mirroring
the house style of apache/camel
(docs/user-manual/.../security-model.adoc + root SECURITY.md + AGENTS.md
with a Security Model section + CLAUDE.md symlink).

File
docs/modules/ROOT/pages/security-model.adoc the threat model (new)
docs/modules/ROOT/nav.adoc links the new page in the user guide nav
SECURITY.md GitHub-rendered reporting pointer to the model + Apache Camel private process (new)
AGENTS.md (+ CLAUDE.md symlink) AI-agent guidelines incl. a Security Model summary (new)

Why / approach

camel-karaf is a runtime adapter, not a new data plane. The data-plane
vulnerability classes (unsafe deserialization, XXE, expression/template
injection, path traversal, SSRF, header/bean-dispatch abuse, auth bypass,
information disclosure, insecure defaults, back-end query injection) live in
Apache Camel core and components. The model therefore defers those to the
canonical Apache Camel Security Model

and documents only the Karaf delta:

  • the camel-core-osgi resolution layer (must not widen, for untrusted
    message data, a class/bean/component sink flat-classpath Camel core had closed);
  • the Blueprint DSL as trusted route-author code (equivalent to Java/XML/YAML DSL);
  • the Karaf shell as a management surface (analogous to camel-management/JMX);
  • the feature / Pax-URL install model as trusted operator action;
  • OSGi is not a security sandbox — the headline false-friend.

It includes a component-family map, input-trust matrix, adversary model,
properties provided / not provided, known non-findings (for automated triage),
a closed set of triage dispositions, and a dated ratification record. The model
is fully ratified; provenance tags are retained as the chain of authority
cited when closing reports.

Produced with the threat-model-producer rubric. No code changes; docs only.
Build gate not affected.


Claude Code on behalf of Andrea Cosentino

🤖 Generated with Claude Code

Adds a Karaf-specific threat model documenting who is trusted, where the
trust boundaries sit, and what counts as a camel-karaf vulnerability versus
an Apache Camel core or operator responsibility.

camel-karaf is a runtime adapter: the data-plane vulnerability classes
(deserialization, XXE, injection, path traversal, header abuse, ...) live
in Apache Camel core and components. This model therefore defers those to
the canonical Apache Camel Security Model and covers only the Karaf delta:
the camel-core-osgi resolution layer, the Blueprint DSL trust position, the
Karaf shell as a management surface, the feature / Pax-URL install model,
and "OSGi is not a security sandbox". The model is fully ratified; provenance
tags are retained as the chain of authority for triage.

- docs/modules/ROOT/pages/security-model.adoc: the threat model, mirroring
  the apache/camel security-model.adoc house style
- docs/modules/ROOT/nav.adoc: link the new page in the user guide nav
- SECURITY.md: GitHub-rendered reporting pointer to the model and the
  Apache Camel private disclosure process
- AGENTS.md (+ CLAUDE.md symlink): AI-agent guidelines incl. a Security
  Model summary, matching the apache/camel AGENTS.md style

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@oscerd oscerd requested review from davsclaus, f2par0 and jbonofre May 15, 2026 16:49
Comment thread docs/modules/ROOT/pages/security-model.adoc
Comment thread AGENTS.md
@@ -0,0 +1,358 @@
# Apache Camel Karaf - AI Agent Guidelines
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ASF header is missing here.

Comment thread SECURITY.md
Comment thread CLAUDE.md
Convert the three in-site links from absolute link:https://camel.apache.org/
URLs to root-relative link:/security/ form, matching apache/camel core
security-model.adoc (apache/camel#23224) and the companion per-subproject
fixes. This keeps PR apache#706 from introducing camel/relative-links failures in
the camel-website build once merged. Documentation-only; same link target.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
@oscerd
Copy link
Copy Markdown
Contributor Author

oscerd commented May 16, 2026

Added commit 627dc0ce7 converting the three in-site link:https://camel.apache.org/... URLs in security-model.adoc to root-relative link:/security/ form. This matches apache/camel core security-model.adoc (apache/camel#23224) and prevents this PR from introducing camel/relative-links failures in the camel-website build once merged (same fix shipped for the sibling per-subproject models: apache/camel-kamelets#2836, apache/camel-kafka-connector#1774, apache/camel-quarkus#8661). Documentation-only; link targets unchanged.

Claude Code on behalf of Andrea Cosentino

Address @jbonofre review on PR apache#706: prepend the ASF Apache License v2
header to the newly added files. AGENTS.md, SECURITY.md use the repository's
existing HTML-comment header (matching README.md); security-model.adoc uses
the AsciiDoc //// comment form. CLAUDE.md is a symlink to AGENTS.md and
inherits the header transitively, so the symlink is intentionally preserved
rather than converted to a regular file.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
@oscerd
Copy link
Copy Markdown
Contributor Author

oscerd commented May 16, 2026

@jbonofre addressed in 605b93c3c: added the ASF license header to AGENTS.md, SECURITY.md (HTML-comment form, matching README.md) and docs/modules/ROOT/pages/security-model.adoc (AsciiDoc //// form). CLAUDE.md is a symlink to AGENTS.md, so it inherits the header transitively — kept it as a symlink rather than converting it to a regular file. Re-requesting review.

Claude Code on behalf of Andrea Cosentino

@oscerd oscerd requested a review from jbonofre May 16, 2026 16:58
@oscerd oscerd merged commit b79bba8 into apache:main May 18, 2026
oscerd added a commit that referenced this pull request May 18, 2026
Convert the three in-site links from absolute link:https://camel.apache.org/
URLs to root-relative link:/security/ form, matching apache/camel core
security-model.adoc (apache/camel#23224) and the companion per-subproject
fixes. This keeps PR #706 from introducing camel/relative-links failures in
the camel-website build once merged. Documentation-only; same link target.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
@oscerd oscerd deleted the docs/security-model branch May 18, 2026 07:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants