#
View Source Ash.Policy.Authorizer (ash v2.14.2)

An authorization extension for ash resources.

To add this extension to a resource, add it to the list of `authorizers` like so:

    use Ash.Resource,
      ...,
      authorizers: [
        Ash.Policy.Authorizer
      ]

A resource can be given a set of policies, which are enforced on each call to a resource action.

For reads, policies can be configured to filter out data that the actor shouldn't see, as opposed to resulting in a forbidden error.

See the policies guide for practical examples.

Policies are solved/managed via a boolean satisfiability solver. To read more about boolean satisfiability, see this page: https://en.wikipedia.org/wiki/Boolean_satisfiability_problem. At the end of the day, however, it is not necessary to understand exactly how Ash takes your authorization requirements and determines if a request is allowed. The important thing to understand is that Ash may or may not run any/all of your authorization rules as they may be deemed unnecessary. As such, authorization checks should have no side effects. Ideally, the checks built-in to ash should cover the bulk of your needs.

##

dsl-documentation

DSL Documentation

###

index

Index

- policies
  - policy
    - authorize_if
    - forbid_if
    - authorize_unless
    - forbid_unless
  - bypass
    - authorize_if
    - forbid_if
    - authorize_unless
    - forbid_unless
- field_policies
  - field_policy_bypass
    - authorize_if
    - forbid_if
    - authorize_unless
    - forbid_unless
  - field_policy
    - authorize_if
    - forbid_if
    - authorize_unless
    - forbid_unless

###

docs

Docs

##

policies

policies

A section for declaring authorization policies.

Each policy that applies must pass independently in order for the request to be authorized.

See the policies guide for more.

- policy
  - authorize_if
  - forbid_if
  - authorize_unless
  - forbid_unless
- bypass
  - authorize_if
  - forbid_if
  - authorize_unless
  - forbid_unless

Examples:

    policies do
      # Anything you can use in a condition, you can use in a check, and vice-versa
      # This policy applies if the actor is a super_user
      # Additionally, this policy is declared as a `bypass`. That means that this check is allowed to fail without
      # failing the whole request, and that if this check *passes*, the entire request passes.
      bypass actor_attribute_equals(:super_user, true) do
        authorize_if always()
      end

      # This will likely be a common occurrence. Specifically, policies that apply to all read actions
      policy action_type(:read) do
        # unless the actor is an active user, forbid their request
        forbid_unless actor_attribute_equals(:active, true)
        # if the record is marked as public, authorize the request
        authorize_if attribute(:public, true)
        # if the actor is related to the data via that data's `owner` relationship, authorize the request
        authorize_if relates_to_actor_via(:owner)
      end
    end

Imports:

- `Ash.Policy.Check.Builtins`
- `Ash.Filter.TemplateHelpers`

- `:default_access_type` - The default access type of policies for this resource. Valid values are :strict, :filter, :runtime The default value is `:filter`.

###

policy

policy

A policy has a name, a condition, and a list of checks.

Checks apply logically in the order they are specified, from top to bottom. If no check explicitly authorizes the request, then the request is forbidden. This means that, if you want to "blacklist" instead of "whitelist", you likely want to add an `authorize_if always()` at the bottom of your policy, like so:

    policy action_type(:read) do
      forbid_if not_logged_in()
      forbid_if user_is_denylisted()
      forbid_if user_is_in_denylisted_group()

      authorize_if always()
    end

If the policy should always run, use the `always()` check, like so:

    policy always() do
      ...
    end

See the policies guide for more.

- authorize_if

- forbid_if

- authorize_unless

- forbid_unless

- `:description` (`String.t/0`) - A description for the policy, used when explaining authorization results

- `:access_type` - What portion of the checks inside the policy are allowed to run. See the guide for more. Valid values are :strict, :filter, :runtime

- `:condition` - A check or list of checks that must be true in order for this policy to apply.

##### authorize_if

If the check is true, the request is authorized, otherwise run remaining checks.

Examples:

    authorize_if logged_in()

    authorize_if actor_attribute_matches_record(:group, :group)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### forbid_if

If the check is true, the request is forbidden, otherwise run remaining checks.

Examples:

    forbid_if not_logged_in()

    forbid_if actor_attribute_matches_record(:group, :blacklisted_groups)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### authorize_unless

If the check is false, the request is authorized, otherwise run remaining checks.

Examples:

    authorize_unless not_logged_in()

    authorize_unless actor_attribute_matches_record(:group, :blacklisted_groups)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### forbid_unless

If the check is true, the request is forbidden, otherwise run remaining checks.

Examples:

    forbid_unless logged_in()

    forbid_unless actor_attribute_matches_record(:group, :group)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

###

bypass

bypass

A policy that, if passed, will skip all following policies. If failed, authorization moves on to the next policy

- authorize_if

- forbid_if

- authorize_unless

- forbid_unless

- `:description` (`String.t/0`) - A description for the policy, used when explaining authorization results

- `:access_type` - What portion of the checks inside the policy are allowed to run. See the guide for more. Valid values are :strict, :filter, :runtime

- `:condition` - A check or list of checks that must be true in order for this policy to apply.

##### authorize_if

If the check is true, the request is authorized, otherwise run remaining checks.

Examples:

    authorize_if logged_in()

    authorize_if actor_attribute_matches_record(:group, :group)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### forbid_if

If the check is true, the request is forbidden, otherwise run remaining checks.

Examples:

    forbid_if not_logged_in()

    forbid_if actor_attribute_matches_record(:group, :blacklisted_groups)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### authorize_unless

If the check is false, the request is authorized, otherwise run remaining checks.

Examples:

    authorize_unless not_logged_in()

    authorize_unless actor_attribute_matches_record(:group, :blacklisted_groups)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### forbid_unless

If the check is true, the request is forbidden, otherwise run remaining checks.

Examples:

    forbid_unless logged_in()

    forbid_unless actor_attribute_matches_record(:group, :group)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##

field_policies

field_policies

Authorize access to specific fields via policies scoped to fields.

If any field policies exist then all fields must be authorized by a field policy. If you want a "deny-list" style, then you can add policies for specific fields and add a catch-all policy using the special field name `:*`. All policies that apply to a field must be authorized.

The only exception to the above behavior is primary keys, which can always be read by everyone.

Additionally, keep in mind that adding `Ash.Policy.Authorizer` will require that all actions pass policies. If you want to just add field policies, you will need to add a policy that allows all access explicitly, i.e

    policies do
      policy always() do
        authorize_if always()
      end
    end

Using expressions: unlike in regular policies, expressions in field policies cannot refer to related entities currently. Instead, you will need to create aggregates or expression calculations that return the results you want to reference.

In results, forbidden fields will be replaced with a special value: `%Ash.ForbiddenField{}`.

When these fields are referred to in filters, they will be replaced with an expression that evaluates to `nil`. To support this behavior, only expression/filter checks are allowed in field policies.

- field_policy_bypass
  - authorize_if
  - forbid_if
  - authorize_unless
  - forbid_unless
- field_policy
  - authorize_if
  - forbid_if
  - authorize_unless
  - forbid_unless

Examples:

    field_policies do
      field_policy :admin_only_field do
        authorize_if actor_attribute_equals(:admin, true)
      end
    end

    # Example of denylist style
    field_policies do
      field_policy [:sensitive, :fields] do
        authorize_if actor_attribute_equals(:admin, true)
      end

      field_policy :* do
        authorize_if always()
      end
    end

Imports:

- `Ash.Policy.Check.Builtins`
- `Ash.Filter.TemplateHelpers`

###

field_policy_bypass

field_policy_bypass

A field policy that, if passed, will skip all following field policies for that field or fields. If failed, field authorization moves on to the next policy

- authorize_if

- forbid_if

- authorize_unless

- forbid_unless

- `:description` (`String.t/0`) - A description for the policy, used when explaining authorization results

- `:fields` - The field or fields that the policy applies to.

- `:condition` - A check or list of checks that must be true in order for this field policy to apply. If not specified, it always applies.

##### authorize_if

If the check is true, the request is authorized, otherwise run remaining checks.

Examples:

    authorize_if logged_in()

    authorize_if actor_attribute_matches_record(:group, :group)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### forbid_if

If the check is true, the request is forbidden, otherwise run remaining checks.

Examples:

    forbid_if not_logged_in()

    forbid_if actor_attribute_matches_record(:group, :blacklisted_groups)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### authorize_unless

If the check is false, the request is authorized, otherwise run remaining checks.

Examples:

    authorize_unless not_logged_in()

    authorize_unless actor_attribute_matches_record(:group, :blacklisted_groups)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### forbid_unless

If the check is true, the request is forbidden, otherwise run remaining checks.

Examples:

    forbid_unless logged_in()

    forbid_unless actor_attribute_matches_record(:group, :group)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

###

field_policy

field_policy

Field policies behave similarly to policies. See `Ash.Policy.Authorizer.field_policies` for more.

- authorize_if

- forbid_if

- authorize_unless

- forbid_unless

- `:description` (`String.t/0`) - A description for the policy, used when explaining authorization results

- `:fields` - The field or fields that the policy applies to.

- `:condition` - A check or list of checks that must be true in order for this field policy to apply. If not specified, it always applies.

##### authorize_if

If the check is true, the request is authorized, otherwise run remaining checks.

Examples:

    authorize_if logged_in()

    authorize_if actor_attribute_matches_record(:group, :group)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### forbid_if

If the check is true, the request is forbidden, otherwise run remaining checks.

Examples:

    forbid_if not_logged_in()

    forbid_if actor_attribute_matches_record(:group, :blacklisted_groups)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### authorize_unless

If the check is false, the request is authorized, otherwise run remaining checks.

Examples:

    authorize_unless not_logged_in()

    authorize_unless actor_attribute_matches_record(:group, :blacklisted_groups)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

##### forbid_unless

If the check is true, the request is forbidden, otherwise run remaining checks.

Examples:

    forbid_unless logged_in()

    forbid_unless actor_attribute_matches_record(:group, :group)

- `:check` - Required. The check to run.
  See `Ash.Policy.Check` for more.

- `:name` (`String.t/0`) - A short name or description for the check, used when explaining authorization results

# Link to this section Summary

## Types

t()

## Functions

print_tuple_boolean(v)

# Link to this section Types

Link to this type

# t()

View Source

    @type t() :: %Ash.Policy.Authorizer{
      action: term(),
      action_input: term(),
      actor: term(),
      api: term(),
      changeset: term(),
      check_scenarios: term(),
      data: term(),
      data_facts: term(),
      facts: term(),
      policies: term(),
      query: term(),
      real_scenarios: term(),
      resource: term(),
      scenarios: term(),
      verbose?: term()
    }

# Link to this section Functions

Link to this function

# print_tuple_boolean(v)

View Source