Configuring proxy roles for applications

Proxy roles allow an authenticated account (role) to run CQL statements using a different role.

DSE proxy management allows roles to log in and execute CQL queries as other roles. This is particularly useful for secure middleware like web servers; the web server can log in once and proxy execute queries as its clients, keeping the audit log intact and leveraging DSE role-based access control.

Application authentication and role assignment

The application sends its own credentials, or in the example above a Kerberos ticket, which is validated by DSE. The authenticated user name for the application is passed to DSE Role Manager. The role_management_options mode setting determines how roles are assigned to authenticated users, when using:
  • internal roles are assigned to authenticated users by matching the user name supplied in the credentials to a role name.

    In the example above, the full principle name for the application including REALM must match the role name.

  • ldap looks up the authenticated user in LDAP and returns a list of groups, then matches the group names to role names.

    For LDAP the group names of the application account must match the role that can proxy other roles.

    Note: Any members of a group can be assigned the role. When using proxy roles with LDAP group management, create a single group-role pair for the application account. The group in LDAP should only contain one member, the application account.
Warning:

When creating the primary role for the application account, you must ensure that the correct role is matched by Role Manager to that account.

Associating proxy roles with the application account

For users that will never directly access DSE, DataStax recommends creating proxy roles that are not bound to an authentication scheme and have no additional options, such as LOGIN, PASSWORD, and SUPERUSER. Therefore, when the authorization_options scheme_permissions are set to true, the role can be used only by the corresponding application account.

To establish an application role using the DSE Role Manager internal mode:

Procedure

  1. Create an application role based on the authentication scheme:
    • Internal scheme:
      CREATE ROLE role_name WITH LOGIN = true AND PASSWORD = 'password';
    • LDAP scheme:
      CREATE ROLE LDAP_service_account WITH LOGIN = true;

      where LDAP_service_account matches the attribute specified for the authentication_options user_filter, such as UID or samAccountName or when using role management with LDAP a group name assigned to the service account in LDAP.

    • Kerberos scheme:
      CREATE ROLE 'user_principal_name' WITH LOGIN = true;

      where user_principal_name matches the full case-sensitive user principal name, such as jane@EXAMPLE.COM.

      Note: An internally stored password is required when authenticating against the internal scheme. The application role does not require permissions to database objects.
  2. Create proxy role without login option:
    CREATE ROLE proxy_role_name;
    Note: DataStax recommends managing the proxy accounts as permission sets without LOGIN, SUPERUSER, and PASSWORD (internally stored passwords).
  3. Assign permissions on database resources to the proxy role:
    GRANT permission_name ON resource_name TO proxy_role_name;
    Note: Repeat the GRANT statement for each permission you want to assign. For a complete list of permissions and supported database objects, see the CQL Permissions matrix.
  4. Associate the application role with the proxy role:
    • Allow the service role to proxy all requests after authenticating:
      GRANT PROXY.LOGIN ON proxy_role_name TO service_role_name;
    • Allow the service role to proxy each request after authenticating:
      GRANT PROXY.EXECUTE ON proxy_role_name TO service_role_name;
  5. Test that the application role can run commands with the proxy role:
    1. Start CQL shell with the application role credentials:
      cqlsh -u application_role_name
      Password:
      Warning: Providing the password from the command line using the -p option provides the password in plain text and may be accessible through the terminal history to any other user with access to the machine.
    2. Start session using the proxy role:
      EXECUTE AS proxy_role_name;
    3. Run CQL statements to verify permissions.
    4. Stop executing CQL statements using the proxy role:
      EXECUTE AS

Example

Another use case for proxy roles is to track workflows. In this example, create an application account for the cycling web application and corresponding proxy accounts for team management and cyclist expenses workflows.

  1. Create a role for the cycling app using internal authentication:
    CREATE ROLE cycling_app WITH LOGIN=true AND PASSWORD='password';
    GRANT EXECUTE ON INTERNAL SCHEME TO cycling_app;
    Note: Binding the role to the authentication scheme is required only when the authentication_options scheme_permissions is set to true.
  2. Create role with permissions to manage expenses:
    1. Create the proxy role:
      CREATE ROLE cycling_expense_management;
    2. Assign access permissions to the role:
      GRANT MODIFY ON cycling.cyclist_expenses to cycling_expense_management;
  3. Create a role to manage cycling teams:
    CREATE ROLE update_teams;
    GRANT MODIFY ON cycling.cyclist_name TO update_teams;
    GRANT MODIFY ON cycling.cyclist_teams TO update_teams;
    GRANT MODIFY ON cycling.cyclist_id TO update_teams;
    
  4. Allow the cycling application to run CQL commands using the team management and expense management roles:
    GRANT PROXY.EXECUTE ON ROLE cycling_expense_management to cycling_app;
    GRANT PROXY.EXECUTE ON ROLE update_teams to cycling_app;
    
  5. Test execution of commands from cycling application role:
    cqlsh -u cycling_app -p 'password' -e "EXECUTE AS cycling_expense_management; INSERT INTO cycling.cyclist_expenses (cyclist_name,expense_id,amount,description) VALUES ('Michael MATTHEWS',47,25,'lunch');"
    Since inserts only return a message with errors, the only output should be that the query executed with the correct role:
    Executing queries as cycling_expense_management.