org.apache.cassandra.auth

## Interface IAuthorizer

- All Known Implementing Classes:
    AllowAllAuthorizer, CassandraAuthorizer

      public interface IAuthorizer

  Primary Cassandra authorization interface.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Set<Permission>` | `authorize(AuthenticatedUser user, IResource resource)` Returns a set of permissions of a user on a resource.
    `void` | `grant(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource grantee)` Grants a set of permissions on a resource to a role.
    `java.util.Set<PermissionDetails>` | `list(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource grantee)` Returns a list of permissions on a resource granted to a role.
    `java.util.Set<? extends IResource>` | `protectedResources()` Set of resources that should be made inaccessible to users and only accessible internally.
    `default boolean` | `requireAuthorization()` Whether or not the authorizer will attempt authorization.
    `void` | `revoke(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource revokee)` Revokes a set of permissions on a resource from a user.
    `void` | `revokeAllFrom(RoleResource revokee)` Called before deleting a role with DROP ROLE statement (or the alias provided for compatibility, DROP USER) so that a new role with the same name wouldn't inherit permissions of the deleted one in the future.
    `void` | `revokeAllOn(IResource droppedResource)` This method is called after a resource is removed (i.e.
    `void` | `setup()` Setup is called once upon system startup to initialize the IAuthorizer.
    `void` | `validateConfiguration()` Validates configuration of IAuthorizer implementation (if configurable).

- - ### Method Detail

    - #### requireAuthorization

          default boolean requireAuthorization()

      Whether or not the authorizer will attempt authorization. If false the authorizer will not be called for authorization of resources.

    - #### authorize

          java.util.Set<Permission> authorize(AuthenticatedUser user,
                                              IResource resource)

      Returns a set of permissions of a user on a resource. Since Roles were introduced in version 2.2, Cassandra does not distinguish in any meaningful way between users and roles. A role may or may not have login privileges and roles may be granted to other roles. In fact, Cassandra does not really have the concept of a user, except to link a client session to role. AuthenticatedUser can be thought of as a manifestation of a role, linked to a specific client connection.
      Parameters:
        `user` - Authenticated user requesting authorization.
        `resource` - Resource for which the authorization is being requested. @see DataResource.
      Returns:
        Set of permissions of the user on the resource. Should never return null. Use Permission.NONE instead.

    - #### grant

          void grant(AuthenticatedUser performer,
                     java.util.Set<Permission> permissions,
                     IResource resource,
                     RoleResource grantee)
              throws RequestValidationException,
                     RequestExecutionException

      Grants a set of permissions on a resource to a role. The opposite of revoke(). This method is optional and may be called internally, so implementations which do not support it should be sure to throw UnsupportedOperationException.
      Parameters:
        `performer` - User who grants the permissions.
        `permissions` - Set of permissions to grant.
        `resource` - Resource on which to grant the permissions.
        `grantee` - Role to which the permissions are to be granted.
      Throws:
        `RequestValidationException`
        `RequestExecutionException`
        `java.lang.UnsupportedOperationException`

    - #### revoke

          void revoke(AuthenticatedUser performer,
                      java.util.Set<Permission> permissions,
                      IResource resource,
                      RoleResource revokee)
               throws RequestValidationException,
                      RequestExecutionException

      Revokes a set of permissions on a resource from a user. The opposite of grant(). This method is optional and may be called internally, so implementations which do not support it should be sure to throw UnsupportedOperationException.
      Parameters:
        `performer` - User who revokes the permissions.
        `permissions` - Set of permissions to revoke.
        `revokee` - Role from which to the permissions are to be revoked.
        `resource` - Resource on which to revoke the permissions.
      Throws:
        `RequestValidationException`
        `RequestExecutionException`
        `java.lang.UnsupportedOperationException`

    - #### list

          java.util.Set<PermissionDetails> list(AuthenticatedUser performer,
                                                java.util.Set<Permission> permissions,
                                                IResource resource,
                                                RoleResource grantee)
                                         throws RequestValidationException,
                                                RequestExecutionException

      Returns a list of permissions on a resource granted to a role. This method is optional and may be called internally, so implementations which do not support it should be sure to throw UnsupportedOperationException.
      Parameters:
        `performer` - User who wants to see the permissions.
        `permissions` - Set of Permission values the user is interested in. The result should only include the matching ones.
        `resource` - The resource on which permissions are requested. Can be null, in which case permissions on all resources should be returned.
        `grantee` - The role whose permissions are requested. Can be null, in which case permissions of every role should be returned.
      Returns:
        All of the matching permission that the requesting user is authorized to know about.
      Throws:
        `RequestValidationException`
        `RequestExecutionException`
        `java.lang.UnsupportedOperationException`

    - #### revokeAllFrom

          void revokeAllFrom(RoleResource revokee)

      Called before deleting a role with DROP ROLE statement (or the alias provided for compatibility, DROP USER) so that a new role with the same name wouldn't inherit permissions of the deleted one in the future. This removes all permissions granted to the Role in question. This method is optional and may be called internally, so implementations which do not support it should be sure to throw UnsupportedOperationException.
      Parameters:
        `revokee` - The role to revoke all permissions from.
      Throws:
        `java.lang.UnsupportedOperationException`

    - #### revokeAllOn

          void revokeAllOn(IResource droppedResource)

      This method is called after a resource is removed (i.e. keyspace, table or role is dropped) and revokes all permissions granted on the IResource in question. This method is optional and may be called internally, so implementations which do not support it should be sure to throw UnsupportedOperationException.
      Parameters:
        `droppedResource` - The resource to revoke all permissions on.
      Throws:
        `java.lang.UnsupportedOperationException`

    - #### protectedResources

          java.util.Set<? extends IResource> protectedResources()

      Set of resources that should be made inaccessible to users and only accessible internally.
      Returns:
        Keyspaces, column families that will be unmodifiable by users; other resources.

    - #### validateConfiguration

          void validateConfiguration()
                              throws ConfigurationException

      Validates configuration of IAuthorizer implementation (if configurable).
      Throws:
        `ConfigurationException` - when there is a configuration error.

    - #### setup

          void setup()

      Setup is called once upon system startup to initialize the IAuthorizer. For example, use this method to create any required keyspaces/column families.

Copyright © 2018 The Apache Software Foundation