This is an automated email from the ASF dual-hosted git repository.
jbonofre pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/karaf.git
The following commit(s) were added to refs/heads/main by this push:
new f0bd4a1ddb docs: clarify how SECURITY.md treats commands of optional
features (#3063)
f0bd4a1ddb is described below
commit f0bd4a1ddbf3ba86b4ca2113052c79f27901e68f
Author: JB Onofré <[email protected]>
AuthorDate: Thu Nov 5 16:36:26 2026 +0000
docs: clarify how SECURITY.md treats commands of optional features (#3063)
* docs: clarify how SECURITY.md treats commands of optional features
The shipped command ACLs cover the features that Karaf installs at
startup. A feature that an admin installs later can add commands with no
ACL, including commands that run code (for example groovy:exec before
the groovy scope got an ACL).
Say so in the "Roles and ACLs" section, limit the viewer vulnerability
case to a Karaf with only its boot features, and list a missing ACL on a
command added by an optional feature as hardening.
* docs: reword SECURITY.md for commands added by features
Say that the command ACL rules apply to the commands a feature adds,
scope the viewer vulnerability to the default installation (featuresBoot)
and to what the shipped ACLs open to viewer, and say in the hardening
section that only an admin can install a feature, that the admin should
check the commands it adds, and that we ship a default ACL when we find
such a command.
---
SECURITY.md | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/SECURITY.md b/SECURITY.md
index 3b016699a5..34facf13a5 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -92,8 +92,9 @@ ACLs decide which roles can run each console command
(`etc/org.apache.karaf.comm
MBean operation (`etc/jmx.acl*.cfg`). A rule can match the command or
operation name only, or also its arguments.
A command that has no ACL can be run by any user who can log in to the
console, including a viewer. Karaf ships ACLs
for the most sensitive commands (installing features, bundles and KAR files,
running operating system commands,
-changing users and ACLs), but not for every command that changes state (for
example `log:set`). To restrict the
-commands that have no ACL, set `karaf.secured.command.compulsory.roles` in
`etc/system.properties`. See the
+changing users and ACLs), but not for every command that changes state (for
example `log:set`). Installing a feature
+can add commands to the console, and the same rule applies to them. To
restrict the commands that have no ACL, set
+`karaf.secured.command.compulsory.roles` in `etc/system.properties`. See the
[security section of the user
guide](manual/src/main/asciidoc/user-guide/security.adoc) for details.
### What we treat as a vulnerability
@@ -105,7 +106,8 @@ commands that have no ACL, set
`karaf.secured.command.compulsory.roles` in `etc/
`admin` role.
- A user with only the `viewer` role (and `ssh`) installs or runs code,
changes users, roles or ACLs, or gets the
effect of an operation that the shipped ACLs reserve to `manager` or `admin`
through a command or operation open
- to them.
+ to them. This covers the default installation (the features listed in
`featuresBoot` in
+ `etc/org.apache.karaf.features.cfg`) and the commands and operations that a
shipped ACL opens to `viewer`.
- A user without the `systembundles` role starts, stops, updates or uninstalls
a system bundle through the bundle
commands or MBean operations.
@@ -121,6 +123,10 @@ These aren't vulnerabilities. We welcome reports and fix
them as regular bugs:
command name when you need a strict limit.
- A command with no ACL changes the state of Karaf, as long as it doesn't give
the effect of an operation that the
shipped ACLs reserve to a higher role.
+- A command added by a feature that Karaf doesn't install by default has no
ACL, and lets users who can log in run
+ code or do more than their roles allow. Only an `admin` can install a
feature. Before you install one, check the
+ commands it adds, and add an ACL for their scope or set
`karaf.secured.command.compulsory.roles`. When we find such
+ a command, we ship a default ACL for it.
### What isn't a vulnerability