Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-8842

security should use an API to expose the permission name instead of using HTTP params

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 6.1, 7.0
    • Component/s: None
    • Labels:

      Description

      Currently the well-known permissions are using the HTTP atributes, such as method, uri, params etc to identify the corresponding permission name such as 'read', 'update' etc. Expose this value through an API so that it can be more accurate and handle various versions of the API

      RequestHandlers will be able to implement an interface to provide the name

      interface PermissionNameProvider {
           Name getPermissionName(SolrQueryRequest req)
      }
      

      This means many significant changes to the API
      1) name does not mean a set of http attributes. Name is decided by the requesthandler . Which means it's possible to use the same name across different permissions.
      examples

      {
      "permissions": [
          {//this permission applies to all collections
            "name": "read",
            "role": "dev"
          },
          {
           
           // this applies to only collection x. But both means you are hitting a read type API
            "name": "read",
            "collection": "x",
            "role": "x_dev"
          }
        ]
      }
      

      2) so far we have been using the name as something unique. We use the name to do an update-permission , delete-permission or even when you wish to insert a permission before another permission we used to use the name. Going forward it is not possible. Every permission will get an implicit index. example

      {
        "permissions": [
          {
            "name": "read",
            "role": "dev",
             //this attribute is automatically assigned by the system
            "index" : 1
          },
          {
            "name": "read",
            "collection": "x",
            "role": "x_dev",
            "index" : 2
          }
        ]
      }
      

      3) example update commands

      {
        "set-permission" : {
          "index": 2,
          "name": "read",
          "collection" : "x",
          "role" :["xdev","admin"]
        },
        //this deletes the permission at index 2
        "delete-permission" : 2,
        //this will insert the command before the first item
        "set-permission": {
          "name":"config-edit",
          "role":"admin",
          "before":1
        }
      }
      

      4) you could construct a permission purely with http attributes and you don't need any name for that. As expected, this will be appended atthe end of the list of permissions

      {
        "set-permission": {
                           "collection": null,
                           "path":"/admin/collections",
                           "params":{"action":[LIST, CREATE]},
                           "role": "admin"}
      }
      

      Users with existing configuration will not observe any change in behavior. But the commands issued to manipulate the permissions will be different .

        Attachments

        1. SOLR-8842.patch
          64 kB
          Noble Paul
        2. SOLR-8842.patch
          64 kB
          Noble Paul

          Activity

            People

            • Assignee:
              noble.paul Noble Paul
              Reporter:
              noble.paul Noble Paul
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: