Introduce role description field

docs/changelog/107088.yaml

@@ -0,0 +1,5 @@
+pr: 107088
+summary: Introduce role description field
+area: Authorization
+type: enhancement
+issues: []

server/src/main/java/org/elasticsearch/TransportVersions.java

@@ -193,6 +193,7 @@ static TransportVersion def(int id) {
     public static final TransportVersion NO_GLOBAL_RETENTION_FOR_SYSTEM_DATA_STREAMS = def(8_650_00_0);
     public static final TransportVersion SHUTDOWN_REQUEST_TIMEOUTS_FIX = def(8_651_00_0);
     public static final TransportVersion INDEXING_PRESSURE_REQUEST_REJECTIONS_COUNT = def(8_652_00_0);
+    public static final TransportVersion SECURITY_ROLE_DESCRIPTION = def(8_653_00_0);
 
     /*
      * STOP! READ THIS FIRST! No, really,

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/action/role/PutRoleRequest.java

@@ -46,6 +46,7 @@ public class PutRoleRequest extends ActionRequest {
     private List<RoleDescriptor.RemoteIndicesPrivileges> remoteIndicesPrivileges = new ArrayList<>();
     private RemoteClusterPermissions remoteClusterPermissions = RemoteClusterPermissions.NONE;
     private boolean restrictRequest = false;
+    private String description;
 
     public PutRoleRequest() {}
 
@@ -63,6 +64,10 @@ public void name(String name) {
         this.name = name;
     }
 
+    public void description(String description) {
+        this.description = description;
+    }
+
     public void cluster(String... clusterPrivilegesArray) {
         this.clusterPrivileges = clusterPrivilegesArray;
     }
@@ -164,6 +169,10 @@ public String name() {
         return name;
     }
 
+    public String description() {
+        return description;
+    }
+
     public String[] cluster() {
         return clusterPrivileges;
     }
@@ -213,7 +222,8 @@ public RoleDescriptor roleDescriptor() {
             Collections.emptyMap(),
             remoteIndicesPrivileges.toArray(new RoleDescriptor.RemoteIndicesPrivileges[0]),
             remoteClusterPermissions,
-            null
+            null,
+            description
         );
     }
 }

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/action/role/PutRoleRequestBuilder.java

@@ -21,7 +21,7 @@
  */
 public class PutRoleRequestBuilder extends ActionRequestBuilder<PutRoleRequest, PutRoleResponse> {
 
-    private static final RoleDescriptor.Parser ROLE_DESCRIPTOR_PARSER = RoleDescriptor.parserBuilder().build();
+    private static final RoleDescriptor.Parser ROLE_DESCRIPTOR_PARSER = RoleDescriptor.parserBuilder().allowDescription(true).build();
 
     public PutRoleRequestBuilder(ElasticsearchClient client) {
         super(client, PutRoleAction.INSTANCE, new PutRoleRequest());
@@ -43,6 +43,7 @@ public PutRoleRequestBuilder source(String name, BytesReference source, XContent
         request.addApplicationPrivileges(descriptor.getApplicationPrivileges());
         request.runAs(descriptor.getRunAs());
         request.metadata(descriptor.getMetadata());
+        request.description(descriptor.getDescription());
         return this;
     }
 
@@ -51,6 +52,11 @@ public PutRoleRequestBuilder name(String name) {
         return this;
     }
 
+    public PutRoleRequestBuilder description(String description) {
+        request.description(description);
+        return this;
+    }
+
     public PutRoleRequestBuilder cluster(String... cluster) {
         request.cluster(cluster);
         return this;

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/action/role/RoleDescriptorRequestValidator.java

@@ -14,6 +14,7 @@
 import org.elasticsearch.xpack.core.security.authz.privilege.IndexPrivilege;
 import org.elasticsearch.xpack.core.security.authz.restriction.WorkflowResolver;
 import org.elasticsearch.xpack.core.security.support.MetadataUtils;
+import org.elasticsearch.xpack.core.security.support.Validation;
 
 import java.util.Arrays;
 import java.util.Set;
@@ -102,6 +103,12 @@ public static ActionRequestValidationException validate(
                 }
             }
         }
+        if (roleDescriptor.getDescription() != null) {
+            Validation.Error error = Validation.Roles.validateRoleDescription(roleDescriptor.getDescription());
+            if (error != null) {
+                validationException = addValidationError(error.toString(), validationException);
+            }
+        }
         return validationException;
     }
 }

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/authc/CrossClusterAccessSubjectInfo.java

@@ -224,7 +224,10 @@ public static final class RoleDescriptorsBytes implements Writeable {
 
         public static final RoleDescriptorsBytes EMPTY = new RoleDescriptorsBytes(new BytesArray("{}"));
 
-        private static final RoleDescriptor.Parser ROLE_DESCRIPTOR_PARSER = RoleDescriptor.parserBuilder().build();
+        private static final RoleDescriptor.Parser ROLE_DESCRIPTOR_PARSER = RoleDescriptor.parserBuilder()
+            .allowRestriction(true)
+            .allowDescription(true)
+            .build();
 
         private final BytesReference rawBytes;
 

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/authz/RoleDescriptor.java

@@ -49,6 +49,8 @@
 import java.util.Map;
 import java.util.Objects;
 
+import static org.elasticsearch.common.xcontent.XContentHelper.createParserNotCompressed;
+
 /**
  * A holder for a Role that contains user-readable information about the Role
  * without containing the actual Role object.
@@ -70,6 +72,7 @@ public class RoleDescriptor implements ToXContentObject, Writeable {
     private final Restriction restriction;
     private final Map<String, Object> metadata;
     private final Map<String, Object> transientMetadata;
+    private final String description;
 
     /**
      * Needed as a stop-gap measure because {@link FieldPermissionsCache} has state (settings) but we need to use one
@@ -93,7 +96,7 @@ public RoleDescriptor(
 
     /**
      * @deprecated Use {@link #RoleDescriptor(String, String[], IndicesPrivileges[], ApplicationResourcePrivileges[],
-     * ConfigurableClusterPrivilege[], String[], Map, Map, RemoteIndicesPrivileges[], RemoteClusterPermissions, Restriction)}
+     * ConfigurableClusterPrivilege[], String[], Map, Map, RemoteIndicesPrivileges[], RemoteClusterPermissions, Restriction, String)}
      */
     @Deprecated
     public RoleDescriptor(
@@ -108,7 +111,7 @@ public RoleDescriptor(
 
     /**
      * @deprecated Use {@link #RoleDescriptor(String, String[], IndicesPrivileges[], ApplicationResourcePrivileges[],
-     * ConfigurableClusterPrivilege[], String[], Map, Map, RemoteIndicesPrivileges[], RemoteClusterPermissions, Restriction)}
+     * ConfigurableClusterPrivilege[], String[], Map, Map, RemoteIndicesPrivileges[], RemoteClusterPermissions, Restriction, String)}
      */
     @Deprecated
     public RoleDescriptor(
@@ -130,7 +133,8 @@ public RoleDescriptor(
             transientMetadata,
             RemoteIndicesPrivileges.NONE,
             RemoteClusterPermissions.NONE,
-            Restriction.NONE
+            Restriction.NONE,
+            null
         );
     }
 
@@ -155,7 +159,8 @@ public RoleDescriptor(
             transientMetadata,
             RemoteIndicesPrivileges.NONE,
             RemoteClusterPermissions.NONE,
-            Restriction.NONE
+            Restriction.NONE,
+            null
         );
     }
 
@@ -170,7 +175,8 @@ public RoleDescriptor(
         @Nullable Map<String, Object> transientMetadata,
         @Nullable RemoteIndicesPrivileges[] remoteIndicesPrivileges,
         @Nullable RemoteClusterPermissions remoteClusterPermissions,
-        @Nullable Restriction restriction
+        @Nullable Restriction restriction,
+        @Nullable String description
     ) {
         this.name = name;
         this.clusterPrivileges = clusterPrivileges != null ? clusterPrivileges : Strings.EMPTY_ARRAY;
@@ -187,6 +193,7 @@ public RoleDescriptor(
             ? remoteClusterPermissions
             : RemoteClusterPermissions.NONE;
         this.restriction = restriction != null ? restriction : Restriction.NONE;
+        this.description = description;
     }
 
     public RoleDescriptor(StreamInput in) throws IOException {
@@ -218,12 +225,21 @@ public RoleDescriptor(StreamInput in) throws IOException {
         } else {
             this.remoteClusterPermissions = RemoteClusterPermissions.NONE;
         }
+        if (in.getTransportVersion().onOrAfter(TransportVersions.SECURITY_ROLE_DESCRIPTION)) {
+            this.description = in.readOptionalString();
+        } else {
+            this.description = null;
+        }
     }
 
     public String getName() {
         return this.name;
     }
 
+    public String getDescription() {
+        return description;
+    }
+
     public String[] getClusterPrivileges() {
         return this.clusterPrivileges;
     }
@@ -338,6 +354,7 @@ public String toString() {
             sb.append(group.toString()).append(",");
         }
         sb.append("], restriction=").append(restriction);
+        sb.append(", description=").append(description);
         sb.append("]");
         return sb.toString();
     }
@@ -358,7 +375,8 @@ public boolean equals(Object o) {
         if (Arrays.equals(runAs, that.runAs) == false) return false;
         if (Arrays.equals(remoteIndicesPrivileges, that.remoteIndicesPrivileges) == false) return false;
         if (remoteClusterPermissions.equals(that.remoteClusterPermissions) == false) return false;
-        return restriction.equals(that.restriction);
+        if (restriction.equals(that.restriction) == false) return false;
+        return Objects.equals(description, that.description);
     }
 
     @Override
@@ -373,6 +391,7 @@ public int hashCode() {
         result = 31 * result + Arrays.hashCode(remoteIndicesPrivileges);
         result = 31 * result + remoteClusterPermissions.hashCode();
         result = 31 * result + restriction.hashCode();
+        result = 31 * result + Objects.hashCode(description);
         return result;
     }
 
@@ -431,6 +450,9 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params, boolea
         if (hasRestriction()) {
             builder.field(Fields.RESTRICTION.getPreferredName(), restriction);
         }
+        if (description != null) {
+            builder.field(Fields.DESCRIPTION.getPreferredName(), description);
+        }
         return builder.endObject();
     }
 
@@ -456,18 +478,23 @@ public void writeTo(StreamOutput out) throws IOException {
         if (out.getTransportVersion().onOrAfter(TransportVersions.ROLE_REMOTE_CLUSTER_PRIVS)) {
             remoteClusterPermissions.writeTo(out);
         }
+        if (out.getTransportVersion().onOrAfter(TransportVersions.SECURITY_ROLE_DESCRIPTION)) {
+            out.writeOptionalString(description);
+        }
     }
 
     public static Parser.Builder parserBuilder() {
         return new Parser.Builder();
     }
 
-    public record Parser(boolean allow2xFormat, boolean allowRestriction) {
+    public record Parser(boolean allow2xFormat, boolean allowRestriction, boolean allowDescription) {
 
         public static final class Builder {
             private boolean allow2xFormat = false;
             private boolean allowRestriction = false;
 
+            private boolean allowDescription = false;
+
             private Builder() {}
 
             public Builder allow2xFormat(boolean allow2xFormat) {
@@ -480,8 +507,13 @@ public Builder allowRestriction(boolean allowRestriction) {
                 return this;
             }
 
+            public Builder allowDescription(boolean allowDescription) {
+                this.allowDescription = allowDescription;
+                return this;
+            }
+
             public Parser build() {
-                return new Parser(allow2xFormat, allowRestriction);
+                return new Parser(allow2xFormat, allowRestriction, allowDescription);
             }
 
         }
@@ -565,6 +597,8 @@ public RoleDescriptor parse(String name, XContentParser parser) throws IOExcepti
                             remoteClusterPermissions = parseRemoteCluster(name, parser);
                         } else if (allowRestriction && Fields.RESTRICTION.match(currentFieldName, parser.getDeprecationHandler())) {
                             restriction = Restriction.parse(name, parser);
+                        } else if (allowDescription && Fields.DESCRIPTION.match(currentFieldName, parser.getDeprecationHandler())) {
+                            description = parser.text();
                         } else if (Fields.TYPE.match(currentFieldName, parser.getDeprecationHandler())) {
                             // don't need it
                         } else {
@@ -586,7 +620,8 @@ public RoleDescriptor parse(String name, XContentParser parser) throws IOExcepti
                 null,
                 remoteIndicesPrivileges,
                 remoteClusterPermissions,
-                restriction
+                restriction,
+                description
             );
 
         }
@@ -686,7 +721,7 @@ public static PrivilegesToCheck parsePrivilegesToCheck(
     }
 
     private static XContentParser createParser(BytesReference source, XContentType xContentType) throws IOException {
-        return XContentHelper.createParserNotCompressed(LoggingDeprecationHandler.XCONTENT_PARSER_CONFIG, source, xContentType);
+        return createParserNotCompressed(LoggingDeprecationHandler.XCONTENT_PARSER_CONFIG, source, xContentType);
     }
 
     public static RoleDescriptor.IndicesPrivileges[] parseIndices(String roleName, XContentParser parser, boolean allow2xFormat)
@@ -1821,5 +1856,6 @@ public interface Fields {
         ParseField TYPE = new ParseField("type");
         ParseField RESTRICTION = new ParseField("restriction");
         ParseField WORKFLOWS = new ParseField("workflows");
+        ParseField DESCRIPTION = new ParseField("description");
     }
 }

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/authz/RoleDescriptorsIntersection.java

@@ -26,7 +26,10 @@ public record RoleDescriptorsIntersection(Collection<Set<RoleDescriptor>> roleDe
 
     public static RoleDescriptorsIntersection EMPTY = new RoleDescriptorsIntersection(Collections.emptyList());
 
-    private static final RoleDescriptor.Parser ROLE_DESCRIPTOR_PARSER = RoleDescriptor.parserBuilder().allowRestriction(true).build();
+    private static final RoleDescriptor.Parser ROLE_DESCRIPTOR_PARSER = RoleDescriptor.parserBuilder()
+        .allowRestriction(true)
+        .allowDescription(true)
+        .build();
 
     public RoleDescriptorsIntersection(RoleDescriptor roleDescriptor) {
         this(List.of(Set.of(roleDescriptor)));

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/authz/store/KibanaOwnedReservedRoleDescriptors.java

@@ -407,6 +407,7 @@ static RoleDescriptor kibanaSystem(String name) {
                 getRemoteIndicesReadPrivileges("traces-apm.*"),
                 getRemoteIndicesReadPrivileges("traces-apm-*") },
             null,
+            null,
             null
         );
     }

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/authz/store/ReservedRolesStore.java

@@ -102,6 +102,7 @@ public class ReservedRolesStore implements BiConsumer<Set<String>, ActionListene
                 new String[] { "*" }
             )
         ),
+        null,
         null
     );
 
@@ -201,6 +202,7 @@ private static Map<String, RoleDescriptor> initializeReservedRoles() {
                         getRemoteIndicesReadPrivileges("/metrics-(beats|elasticsearch|enterprisesearch|kibana|logstash).*/"),
                         getRemoteIndicesReadPrivileges("metricbeat-*") },
                     null,
+                    null,
                     null
                 )
             ),

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/support/Validation.java

@@ -6,6 +6,7 @@
  */
 package org.elasticsearch.xpack.core.security.support;
 
+import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.settings.SecureString;
 import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.xpack.core.security.authc.esnative.ClientReservedRealm;
@@ -204,10 +205,19 @@ public static Error validatePassword(SecureString password) {
 
     public static final class Roles {
 
+        public static final int MAX_DESCRIPTION_LENGTH = 1000;
+
         public static Error validateRoleName(String roleName, boolean allowReserved) {
             return validateRoleName(roleName, allowReserved, MAX_NAME_LENGTH);
         }
 
+        public static Error validateRoleDescription(String description) {
+            if (description != null && description.length() > MAX_DESCRIPTION_LENGTH) {
+                return new Error(Strings.format("Role description must be less than %s characters.", MAX_DESCRIPTION_LENGTH));
+            }
+            return null;
+        }
+
         static Error validateRoleName(String roleName, boolean allowReserved, int maxLength) {
             if (roleName == null) {
                 return new Error("role name is missing");

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/user/SystemUser.java

@@ -46,6 +46,7 @@ public class SystemUser extends InternalUser {
         null,
         null,
         null,
+        null,
         null
     );